NAV
Python Ruby

IQPro.SaaS.API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Authentication

Admin

get_api_Admin_Permission{gatewayId}

GET /api/Admin/Permission/{gatewayId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "permissionId": {
              "type": "string",
              "format": "uuid"
            },
            "code": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "order": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UserPermissionIResult
204 No Content No Content UserPermissionIResult
400 Bad Request Bad Request UserPermissionIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden UserPermissionIResult
500 Internal Server Error Server Error ObjectIResult

get__api_Admin_Role

GET /api/Admin/Role

Parameters

Name In Type Required Description
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isGatewayRole":{"type":"boolean"}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "isGatewayRole": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success RoleDetailsResponseListIResult
204 No Content No Content RoleDetailsResponseListIResult
400 Bad Request Bad Request RoleDetailsResponseListIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden RoleDetailsResponseListIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Admin_Role{gatewayId}

GET /api/Admin/Role/{gatewayId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"roleId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isGatewayRole":{"type":"boolean"}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "isGatewayRole": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success RoleDetailsResponseListIResult
204 No Content No Content RoleDetailsResponseListIResult
400 Bad Request Bad Request RoleDetailsResponseListIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden RoleDetailsResponseListIResult
500 Internal Server Error Server Error ObjectIResult

get__api_Admin_Permission

GET /api/Admin/Permission

Parameters

Name In Type Required Description
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "order": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UserPermissionIEnumerableIResult
204 No Content No Content IResult
400 Bad Request Bad Request UserPermissionIEnumerableIResult
401 Unauthorized Unauthorized UserPermissionIEnumerableIResult
403 Forbidden Forbidden ProblemDetails
500 Internal Server Error Server Error ObjectIResult

get__api_Admin_Units

GET /api/Admin/Units

Parameters

Name In Type Required Description
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"unitOfMeasureId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "unitOfMeasureId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadUnitOfMeasureListStatus
204 No Content No Content ResponseReadUnitOfMeasureListStatus
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ResponseReadUnitOfMeasureListStatus
500 Internal Server Error Server Error ObjectIResult

Customer

get_api_Gateway{gatewayId}Customer{customerId}

GET /api/Gateway/{gatewayId}/Customer/{customerId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"modifiedDateTime":{"type":"string","format":"date-time"},"sourceReferenceId":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"type":"object","properties":{"isPhysical":{"type":"boolean"},"isShipping":{"type":"boolean"},"isBilling":{"type":"boolean"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true},"customerAddressId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"paymentMethods":{"type":"array","items":{"type":"object","properties":{"ach":{"allOf":[{"type":"object","properties":{"achId":{"type":"string","format":"uuid"},"maskedAccount":{"type":"string","nullable":true},"accountType":{"enum":["Checking","Savings"],"type":"string"},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"},"token":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"card":{"allOf":[{"type":"object","properties":{"cardId":{"type":"string","format":"uuid"},"maskedCard":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"cardType":{"enum":["Visa","MasterCard","Discover","AmericanExpress"],"type":"string"},"expirationDate":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"isDefault":{"type":"boolean"},"paymentMethodId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"customFieldEntries":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"customFieldCategoryName":{"type":"string","nullable":true},"customFieldCategoryId":{"type":"integer","format":"int32"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"statistics":{"allOf":[{"type":"object","properties":{"addressesCount":{"type":"integer","format":"int32"},"paymentMethodsCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true},"customerId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "modifiedDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            },
            "addresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "isPhysical": {
                    "type": "boolean"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  },
                  "customerAddressId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "paymentMethods": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ach": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "achId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "maskedAccount": {
                            "type": "string",
                            "nullable": true
                          },
                          "accountType": {
                            "enum": [
                              "Checking",
                              "Savings"
                            ],
                            "type": "string"
                          },
                          "secCode": {
                            "enum": [
                              "PPD",
                              "CCD",
                              "WEB",
                              "TEL"
                            ],
                            "type": "string"
                          },
                          "token": {
                            "type": "string",
                            "nullable": true
                          },
                          "sourceReferenceId": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "card": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "cardId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "maskedCard": {
                            "type": "string",
                            "nullable": true
                          },
                          "token": {
                            "type": "string",
                            "nullable": true
                          },
                          "cardType": {
                            "enum": [
                              "Visa",
                              "MasterCard",
                              "Discover",
                              "AmericanExpress"
                            ],
                            "type": "string"
                          },
                          "expirationDate": {
                            "type": "string",
                            "nullable": true
                          },
                          "sourceReferenceId": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isDefault": {
                    "type": "boolean"
                  },
                  "paymentMethodId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "statistics": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "addressesCount": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "paymentMethodsCount": {
                      "type": "integer",
                      "format": "int32"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomerDetailsModelIResult
204 No Content No Content CustomerDetailsModelIResult
400 Bad Request Bad Request CustomerDetailsModelIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden CustomerDetailsModelIResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}Customer{customerId}

PUT /api/Gateway/{gatewayId}/Customer/{customerId}

Body parameter

{
  "allOf": [
    {
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 50,
          "minLength": 0,
          "type": "string"
        },
        "description": {
          "maxLength": 255,
          "minLength": 0,
          "type": "string",
          "nullable": true
        },
        "customFields": {
          "type": "array",
          "items": {
            "required": [
              "customFieldId",
              "customFieldValue"
            ],
            "type": "object",
            "properties": {
              "customFieldId": {
                "type": "integer",
                "format": "int32"
              },
              "customFieldValue": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomerProcessResponseIResult
400 Bad Request Bad Request CustomerProcessResponseIResult
401 Unauthorized Unauthorized CustomerProcessResponseIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found CustomerProcessResponseIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Customer{customerId}

DELETE /api/Gateway/{gatewayId}/Customer/{customerId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
api-version header string false none

Example responses

400 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden Inline
404 Not Found Not Found ProblemDetails
500 Internal Server Error Server Error ObjectIResult

Response Schema

post_api_Gateway{gatewayId}_Customer

POST /api/Gateway/{gatewayId}/Customer

Body parameter

{
  "allOf": [
    {
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "nullable": true
        },
        "addresses": {
          "maxItems": 25,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "addressLine1": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "addressLine2": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "city": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              },
              "state": {
                "maxLength": 3,
                "type": "string",
                "nullable": true
              },
              "postalCode": {
                "maxLength": 16,
                "type": "string",
                "nullable": true
              },
              "country": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              },
              "firstName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "lastName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "email": {
                "maxLength": 100,
                "type": "string",
                "format": "email",
                "nullable": true
              },
              "phone": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "fax": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "company": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "isShipping": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "isPhysical": {
                "type": "boolean"
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "customFields": {
          "type": "array",
          "items": {
            "required": [
              "customFieldId",
              "customFieldValue"
            ],
            "type": "object",
            "properties": {
              "customFieldId": {
                "type": "integer",
                "format": "int32"
              },
              "customFieldValue": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "payment": {
          "allOf": [
            {
              "required": [
                "isDefault"
              ],
              "type": "object",
              "properties": {
                "card": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "maskedCard": {
                          "maxLength": 19,
                          "minLength": 0,
                          "type": "string",
                          "nullable": true
                        },
                        "token": {
                          "maxLength": 50,
                          "minLength": 0,
                          "type": "string",
                          "nullable": true
                        },
                        "cardType": {
                          "enum": [
                            "Visa",
                            "MasterCard",
                            "Discover",
                            "AmericanExpress",
                            "Diners",
                            "Jcb"
                          ],
                          "type": "string"
                        },
                        "expirationDate": {
                          "maxLength": 5,
                          "minLength": 0,
                          "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "ach": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "maskedAccount": {
                          "maxLength": 50,
                          "minLength": 0,
                          "type": "string",
                          "nullable": true
                        },
                        "accountType": {
                          "enum": [
                            "Checking",
                            "Savings"
                          ],
                          "type": "string"
                        },
                        "secCode": {
                          "enum": [
                            "PPD",
                            "CCD",
                            "WEB",
                            "TEL"
                          ],
                          "type": "string"
                        },
                        "token": {
                          "maxLength": 50,
                          "minLength": 0,
                          "type": "string",
                          "nullable": true
                        },
                        "routingNumber": {
                          "maxLength": 9,
                          "pattern": "\\d{0,9}",
                          "type": "string",
                          "nullable": true
                        },
                        "checkNum": {
                          "type": "integer",
                          "format": "int32",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "isDefault": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created CustomerDetailsBaseModelIResult
400 Bad Request Bad Request CustomerDetailsBaseModelIResult
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}Customer{customerId}_Address

POST /api/Gateway/{gatewayId}/Customer/{customerId}/Address

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "addressLine1": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "addressLine2": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "city": {
          "maxLength": 40,
          "type": "string",
          "nullable": true
        },
        "state": {
          "maxLength": 3,
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "maxLength": 16,
          "type": "string",
          "nullable": true
        },
        "country": {
          "maxLength": 40,
          "type": "string",
          "nullable": true
        },
        "firstName": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "lastName": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "email": {
          "maxLength": 100,
          "type": "string",
          "format": "email",
          "nullable": true
        },
        "phone": {
          "maxLength": 10,
          "pattern": "^(\\d{10})$",
          "type": "string",
          "nullable": true
        },
        "fax": {
          "maxLength": 10,
          "pattern": "^(\\d{10})$",
          "type": "string",
          "nullable": true
        },
        "company": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "isShipping": {
          "type": "boolean"
        },
        "isBilling": {
          "type": "boolean"
        },
        "isPhysical": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerAddressId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerAddressId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created AddressDetailsBaseModelIResult
400 Bad Request Bad Request AddressDetailsBaseModelIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden AddressDetailsBaseModelIResult
404 Not Found Not Found AddressDetailsBaseModelIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Customer{customerId}Address{customerAddressId}

DELETE /api/Gateway/{gatewayId}/Customer/{customerId}/Address/{customerAddressId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
customerAddressId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult`1
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult`1
403 Forbidden Forbidden IResult`1
404 Not Found Not Found IResult`1
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}Customer{customerId}Address{customerAddressId}

PATCH /api/Gateway/{gatewayId}/Customer/{customerId}/Address/{customerAddressId}

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
customerAddressId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerAddressId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerAddressId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success AddressDetailsBaseModelIResult
400 Bad Request Bad Request AddressDetailsBaseModelIResult
401 Unauthorized Unauthorized AddressDetailsBaseModelIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found AddressDetailsBaseModelIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Customer_Search

POST /api/Gateway/{gatewayId}/Customer/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "globalSearch": {
          "maxLength": 100,
          "type": "string",
          "nullable": true
        },
        "customerId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "name": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "description": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "firstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "lastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "company": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "addressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "addressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "city": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "country": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "state": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "postalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "email": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "phone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "fax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "paymentType": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Card",
                    "Ach"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "updatedDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "includeDefaultAddresses": {
          "type": "boolean"
        },
        "includeDefaultPayment": {
          "type": "boolean"
        },
        "includeStats": {
          "type": "boolean"
        },
        "offSet": {
          "maximum": 2147483647,
          "minimum": 0,
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "maximum": 100,
          "minimum": 1,
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"modifiedDateTime":{"type":"string","format":"date-time"},"sourceReferenceId":{"type":"string","nullable":true},"addresses":{"type":"array","items":{"type":"object","properties":{"isPhysical":{"type":"boolean"},"isShipping":{"type":"boolean"},"isBilling":{"type":"boolean"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true},"customerAddressId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"paymentMethods":{"type":"array","items":{"type":"object","properties":{"ach":{"allOf":[{"type":"object","properties":{"achId":{"type":"string","format":"uuid"},"maskedAccount":{"type":"string","nullable":true},"accountType":{"enum":["Checking","Savings"],"type":"string"},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"},"token":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"card":{"allOf":[{"type":"object","properties":{"cardId":{"type":"string","format":"uuid"},"maskedCard":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"cardType":{"enum":["Visa","MasterCard","Discover","AmericanExpress"],"type":"string"},"expirationDate":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"isDefault":{"type":"boolean"},"paymentMethodId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"customFieldEntries":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"customFieldCategoryName":{"type":"string","nullable":true},"customFieldCategoryId":{"type":"integer","format":"int32"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"statistics":{"allOf":[{"type":"object","properties":{"addressesCount":{"type":"integer","format":"int32"},"paymentMethodsCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true},"customerId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  },
                  "addresses": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "isPhysical": {
                          "type": "boolean"
                        },
                        "isShipping": {
                          "type": "boolean"
                        },
                        "isBilling": {
                          "type": "boolean"
                        },
                        "firstName": {
                          "type": "string",
                          "nullable": true
                        },
                        "lastName": {
                          "type": "string",
                          "nullable": true
                        },
                        "company": {
                          "type": "string",
                          "nullable": true
                        },
                        "email": {
                          "type": "string",
                          "nullable": true
                        },
                        "phone": {
                          "type": "string",
                          "nullable": true
                        },
                        "fax": {
                          "type": "string",
                          "nullable": true
                        },
                        "addressLine1": {
                          "type": "string",
                          "nullable": true
                        },
                        "addressLine2": {
                          "type": "string",
                          "nullable": true
                        },
                        "city": {
                          "type": "string",
                          "nullable": true
                        },
                        "state": {
                          "type": "string",
                          "nullable": true
                        },
                        "postalCode": {
                          "type": "string",
                          "nullable": true
                        },
                        "country": {
                          "type": "string",
                          "nullable": true
                        },
                        "sourceReferenceId": {
                          "type": "string",
                          "nullable": true
                        },
                        "customerAddressId": {
                          "type": "string",
                          "format": "uuid"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "paymentMethods": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ach": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "achId": {
                                  "type": "string",
                                  "format": "uuid"
                                },
                                "maskedAccount": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "accountType": {
                                  "enum": [
                                    "Checking",
                                    "Savings"
                                  ],
                                  "type": "string"
                                },
                                "secCode": {
                                  "enum": [
                                    "PPD",
                                    "CCD",
                                    "WEB",
                                    "TEL"
                                  ],
                                  "type": "string"
                                },
                                "token": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "sourceReferenceId": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        },
                        "card": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "cardId": {
                                  "type": "string",
                                  "format": "uuid"
                                },
                                "maskedCard": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "token": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "cardType": {
                                  "enum": [
                                    "Visa",
                                    "MasterCard",
                                    "Discover",
                                    "AmericanExpress"
                                  ],
                                  "type": "string"
                                },
                                "expirationDate": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "sourceReferenceId": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        },
                        "isDefault": {
                          "type": "boolean"
                        },
                        "paymentMethodId": {
                          "type": "string",
                          "format": "uuid"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "customFieldEntries": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "customFieldId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "name": {
                          "type": "string",
                          "nullable": true
                        },
                        "value": {
                          "type": "string",
                          "nullable": true
                        },
                        "modifiedByUserId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "modifiedDateTime": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "type": {
                          "type": "string",
                          "nullable": true
                        },
                        "customFieldCategoryName": {
                          "type": "string",
                          "nullable": true
                        },
                        "customFieldCategoryId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "dataType": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "statistics": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "addressesCount": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "paymentMethodsCount": {
                            "type": "integer",
                            "format": "int32"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "customerId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomerDetailsModelPagedResultIResult
204 No Content No Content CustomerDetailsModelPagedResultIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}Customer{customerId}_Payment

POST /api/Gateway/{gatewayId}/Customer/{customerId}/Payment

Body parameter

{
  "allOf": [
    {
      "required": [
        "isDefault"
      ],
      "type": "object",
      "properties": {
        "card": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "maskedCard": {
                  "maxLength": 19,
                  "minLength": 0,
                  "type": "string",
                  "nullable": true
                },
                "token": {
                  "maxLength": 50,
                  "minLength": 0,
                  "type": "string",
                  "nullable": true
                },
                "cardType": {
                  "enum": [
                    "Visa",
                    "MasterCard",
                    "Discover",
                    "AmericanExpress",
                    "Diners",
                    "Jcb"
                  ],
                  "type": "string"
                },
                "expirationDate": {
                  "maxLength": 5,
                  "minLength": 0,
                  "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "ach": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "maskedAccount": {
                  "maxLength": 50,
                  "minLength": 0,
                  "type": "string",
                  "nullable": true
                },
                "accountType": {
                  "enum": [
                    "Checking",
                    "Savings"
                  ],
                  "type": "string"
                },
                "secCode": {
                  "enum": [
                    "PPD",
                    "CCD",
                    "WEB",
                    "TEL"
                  ],
                  "type": "string"
                },
                "token": {
                  "maxLength": 50,
                  "minLength": 0,
                  "type": "string",
                  "nullable": true
                },
                "routingNumber": {
                  "maxLength": 9,
                  "pattern": "\\d{0,9}",
                  "type": "string",
                  "nullable": true
                },
                "checkNum": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "isDefault": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerPaymentMethodId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerPaymentMethodId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created CustomerPaymentMethodResponseIResult
400 Bad Request Bad Request CustomerPaymentMethodResponseIResult
401 Unauthorized Unauthorized CustomerPaymentMethodResponseIResult
403 Forbidden Forbidden ProblemDetails
404 Not Found Not Found CustomerPaymentMethodResponseIResult
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}Customer{customerId}Payment{customerPaymentId}

PATCH /api/Gateway/{gatewayId}/Customer/{customerId}/Payment/{customerPaymentId}

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
customerPaymentId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customerPaymentMethodId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerPaymentMethodId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomerPaymentMethodResponseIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized CustomerPaymentMethodResponseIResult
403 Forbidden Forbidden ProblemDetails
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Customer{customerId}Payment{customerPaymentId}

DELETE /api/Gateway/{gatewayId}/Customer/{customerId}/Payment/{customerPaymentId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customerId path string(uuid) true none
customerPaymentId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden ProblemDetails
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

CustomField

post_api_Gateway{gatewayId}_CustomFieldCategory

POST /api/Gateway/{gatewayId}/CustomFieldCategory

Body parameter

{
  "allOf": [
    {
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 100,
          "minLength": 2,
          "type": "string"
        },
        "description": {
          "maxLength": 100,
          "minLength": 0,
          "type": "string",
          "nullable": true
        },
        "customer": {
          "type": "boolean"
        },
        "transaction": {
          "type": "boolean"
        },
        "invoice": {
          "type": "boolean"
        },
        "customFields": {
          "type": "array",
          "items": {
            "required": [
              "dataTypeId",
              "name",
              "orderNumber",
              "type"
            ],
            "type": "object",
            "properties": {
              "name": {
                "maxLength": 100,
                "minLength": 2,
                "type": "string"
              },
              "type": {
                "enum": [
                  "Text",
                  "Radio",
                  "Checklist",
                  "Select",
                  "Multiselect"
                ],
                "type": "string"
              },
              "dataTypeId": {
                "type": "integer",
                "format": "int32"
              },
              "orderNumber": {
                "maximum": 2147483647,
                "minimum": 0,
                "type": "integer",
                "format": "int32"
              },
              "isRequired": {
                "type": "boolean"
              },
              "customFieldOption": {
                "type": "array",
                "items": {
                  "required": [
                    "label",
                    "value"
                  ],
                  "type": "object",
                  "properties": {
                    "value": {
                      "maxLength": 25,
                      "minLength": 1,
                      "type": "string"
                    },
                    "label": {
                      "maxLength": 25,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"customFieldCategoryId":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customFieldCategoryId": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertCustomFieldCategoryResponseIResult
400 Bad Request Bad Request InsertCustomFieldCategoryResponseIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden InsertCustomFieldCategoryResponseIResult
409 Conflict Conflict InsertCustomFieldCategoryResponseIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}_CustomFieldCategory

GET /api/Gateway/{gatewayId}/CustomFieldCategory

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldCategoryId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"customer":{"type":"boolean"},"transaction":{"type":"boolean"},"invoice":{"type":"boolean"},"customFields":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"dataType":{"type":"string","nullable":true},"orderNumber":{"type":"integer","format":"int32"},"isRequired":{"type":"boolean"},"customFieldOption":{"type":"array","items":{"type":"object","properties":{"customFieldOptionId":{"type":"integer","format":"int32"},"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "customer": {
            "type": "boolean"
          },
          "transaction": {
            "type": "boolean"
          },
          "invoice": {
            "type": "boolean"
          },
          "customFields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldId": {
                  "type": "integer",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "type": {
                  "type": "string",
                  "nullable": true
                },
                "dataType": {
                  "type": "string",
                  "nullable": true
                },
                "orderNumber": {
                  "type": "integer",
                  "format": "int32"
                },
                "isRequired": {
                  "type": "boolean"
                },
                "customFieldOption": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "customFieldOptionId": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      },
                      "label": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomFieldsTypeResponseListIResult
204 No Content No Content CustomFieldsTypeResponseListIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden CustomFieldsTypeResponseListIResult
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}_CustomFieldCategory

PATCH /api/Gateway/{gatewayId}/CustomFieldCategory

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldCategoryId":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponsePatchCustomFieldCategoryListStatus
207 Multi-Status Success ResponsePatchCustomFieldCategoryListStatus
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponsePatchCustomFieldCategoryListStatus
404 Not Found Not Found ResponsePatchCustomFieldCategoryListStatus
422 Unprocessable Entity Client Error ResponsePatchCustomFieldCategoryListStatus
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}CustomFieldCategory{categoryId}_CustomField

PATCH /api/Gateway/{gatewayId}/CustomFieldCategory/{categoryId}/CustomField

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
categoryId path integer(int32) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success PatchCustomFieldResponseListStatus
207 Multi-Status Success PatchCustomFieldResponseListStatus
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden PatchCustomFieldResponseListStatus
404 Not Found Not Found PatchCustomFieldResponseListStatus
422 Unprocessable Entity Client Error PatchCustomFieldResponseListStatus
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_CustomField

POST /api/Gateway/{gatewayId}/CustomField

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "customFieldCategoryId": {
          "type": "integer",
          "format": "int32"
        },
        "insertCustomField": {
          "type": "array",
          "items": {
            "required": [
              "dataTypeId",
              "name",
              "orderNumber",
              "type"
            ],
            "type": "object",
            "properties": {
              "name": {
                "maxLength": 100,
                "minLength": 2,
                "type": "string"
              },
              "type": {
                "enum": [
                  "Text",
                  "Radio",
                  "Checklist",
                  "Select",
                  "Multiselect"
                ],
                "type": "string"
              },
              "dataTypeId": {
                "type": "integer",
                "format": "int32"
              },
              "orderNumber": {
                "maximum": 2147483647,
                "minimum": 0,
                "type": "integer",
                "format": "int32"
              },
              "isRequired": {
                "type": "boolean"
              },
              "customFieldOption": {
                "type": "array",
                "items": {
                  "required": [
                    "label",
                    "value"
                  ],
                  "type": "object",
                  "properties": {
                    "value": {
                      "maxLength": 25,
                      "minLength": 1,
                      "type": "string"
                    },
                    "label": {
                      "maxLength": 25,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertCustomFieldResponseListIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden InsertCustomFieldResponseListIResult
404 Not Found Not Found InsertCustomFieldResponseListIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}CustomFieldCategory{categoryId}

GET /api/Gateway/{gatewayId}/CustomFieldCategory/{categoryId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
categoryId path integer(int32) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"dataType":{"type":"string","nullable":true},"orderNumber":{"type":"integer","format":"int32"},"isRequired":{"type":"boolean"},"customFieldOption":{"type":"array","items":{"type":"object","properties":{"customFieldOptionId":{"type":"integer","format":"int32"},"value":{"type":"string","nullable":true},"label":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "customFieldOption": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldOptionId": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "label": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success CustomFieldResponseListIResult
204 No Content No Content CustomFieldResponseListIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden CustomFieldResponseListIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}CustomFieldCategory{categoryId}

DELETE /api/Gateway/{gatewayId}/CustomFieldCategory/{categoryId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
categoryId path integer(int32) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}CustomField{customfieldId}_Options

POST /api/Gateway/{gatewayId}/CustomField/{customfieldId}/Options

Body parameter

{
  "type": "array",
  "items": {
    "required": [
      "label",
      "value"
    ],
    "type": "object",
    "properties": {
      "value": {
        "maxLength": 25,
        "minLength": 1,
        "type": "string"
      },
      "label": {
        "maxLength": 25,
        "minLength": 1,
        "type": "string"
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customFieldId path integer(int32) true none
api-version header string false none
body body InsertCustomFieldOption false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"array","items":{"type":"object","properties":{"customFieldOptionId":{"type":"integer","format":"int32"},"label":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldOptionId": {
            "type": "integer",
            "format": "int32"
          },
          "label": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertCustomFieldOptionsResponseListIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden InsertCustomFieldOptionsResponseListIResult
404 Not Found Not Found InsertCustomFieldOptionsResponseListIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}CustomField{customfieldId}

DELETE /api/Gateway/{gatewayId}/CustomField/{customfieldId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customfieldId path integer(int32) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}CustomField{customfieldId}Options{customFieldOptionId}

DELETE /api/Gateway/{gatewayId}/CustomField/{customfieldId}/Options/{customFieldOptionId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
customFieldId path integer(int32) true none
customfieldOptionId path integer(int32) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

Gateway

get__api_Gateway

GET /api/Gateway

Parameters

Name In Type Required Description
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"userStatus":{"enum":["InvitePending","PendingTOS","Active","Disabled"],"type":"string"},"gateways":{"type":"array","items":{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"},"gateway":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"status":{"enum":["Active","Disabled"],"type":"string"},"phone":{"type":"string","nullable":true},"phoneExternal":{"type":"string","nullable":true},"receiptEmail":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            },
            "userStatus": {
              "enum": [
                "InvitePending",
                "PendingTOS",
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "gateways": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gateway": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "gatewayId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          },
                          "status": {
                            "enum": [
                              "Active",
                              "Disabled"
                            ],
                            "type": "string"
                          },
                          "phone": {
                            "type": "string",
                            "nullable": true
                          },
                          "phoneExternal": {
                            "type": "string",
                            "nullable": true
                          },
                          "receiptEmail": {
                            "type": "string",
                            "nullable": true
                          },
                          "website": {
                            "type": "string",
                            "nullable": true
                          },
                          "timezone": {
                            "type": "string",
                            "nullable": true
                          },
                          "createdDateTime": {
                            "type": "string",
                            "format": "date-time"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseGatewayUserDetailWithGatewayIResult
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden ProblemDetails
500 Internal Server Error Server Error ObjectIResult

post__api_Gateway_Search

POST /api/Gateway/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "status": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Active",
                    "Disabled"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "contactCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "contactName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "contactPhoneNumber": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "contactEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "maximum": 2147483647,
          "minimum": 0,
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "maximum": 100,
          "minimum": 1,
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"contactCompany":{"type":"string","nullable":true},"contactName":{"type":"string","nullable":true},"contactPhoneNumber":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"receiptEmail":{"type":"string","nullable":true},"sourceSystem":{"enum":["BASYSIQ","FP"],"type":"string"},"createdDateTime":{"type":"string","format":"date-time"}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "status": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactCompany": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactName": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactPhoneNumber": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactEmail": {
                    "type": "string",
                    "nullable": true
                  },
                  "receiptEmail": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceSystem": {
                    "enum": [
                      "BASYSIQ",
                      "FP"
                    ],
                    "type": "string"
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GatewaySearchResponsePagedResultIResult
204 No Content No Content GatewaySearchResponsePagedResultIResult
400 Bad Request Bad Request GatewaySearchResponsePagedResultIResult
401 Unauthorized Unauthorized GatewaySearchResponsePagedResultIResult
403 Forbidden Forbidden GatewaySearchResponsePagedResultIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}

GET /api/Gateway/{gatewayId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"status":{"enum":["Active","Disabled"],"type":"string"},"name":{"type":"string","nullable":true},"merchantId":{"type":"string","nullable":true},"sourceReferenceId":{"type":"string","nullable":true},"contactCompany":{"type":"string","nullable":true},"contactName":{"type":"string","nullable":true},"contactEmail":{"type":"string","nullable":true},"feeScheduleId":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"phoneExternal":{"type":"string","nullable":true},"receiptEmail":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"addresses":{"type":"array","items":{"type":"object","properties":{"gatewayAddressId":{"type":"string","format":"uuid"},"gatewayId":{"type":"string","format":"uuid"},"addressId":{"type":"string","format":"uuid"},"isPrimary":{"type":"boolean"},"isBilling":{"type":"boolean"},"isInvoice":{"type":"boolean"},"addressModel":{"allOf":[{"required":["addressLine1","firstName"],"type":"object","properties":{"addressLine1":{"maxLength":50,"minLength":1,"type":"string"},"addressLine2":{"maxLength":50,"type":"string","nullable":true},"city":{"maxLength":40,"type":"string","nullable":true},"state":{"maxLength":3,"type":"string","nullable":true},"postalCode":{"maxLength":16,"type":"string","nullable":true},"country":{"maxLength":40,"type":"string","nullable":true},"firstName":{"maxLength":50,"minLength":1,"type":"string"},"lastName":{"maxLength":50,"type":"string","nullable":true},"email":{"maxLength":100,"type":"string","format":"email","nullable":true},"phone":{"maxLength":10,"pattern":"^(\\d{10})$","type":"string","nullable":true},"fax":{"maxLength":10,"pattern":"^(\\d{10})$","type":"string","nullable":true},"company":{"maxLength":50,"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false},"nullable":true},"processors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"processorId":{"type":"string","format":"uuid"},"processorType":{"allOf":[{"type":"object","properties":{"processorTypeId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"type":{"enum":["CreditCard","Ach"],"type":"string"}},"additionalProperties":false}],"nullable":true},"merchantId":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"paymentAdjustmentTypeId":{"enum":["NoAdj","Flat","Percentage"],"type":"string"},"paymentAdjustmentType":{"type":"string","nullable":true},"paymentAdjustmentLabel":{"enum":["NoLabel","ConvenienceFee","ServiceFee","AdminFee","ShippingHandlingFee"],"type":"string"},"paymentAdjustmentValue":{"type":"number","format":"double","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"preferences":{"type":"array","items":{"type":"object","properties":{"metadataId":{"type":"integer","format":"int32"},"preferenceName":{"type":"string","nullable":true},"metadataName":{"type":"string","nullable":true},"metadataValue":{"type":"string","nullable":true},"metadataDisplayName":{"type":"string","nullable":true},"metadataDescription":{"type":"string","nullable":true},"metadataDataType":{"type":"string","nullable":true},"isPublic":{"type":"boolean"}},"additionalProperties":false},"nullable":true},"settings":{"allOf":[{"type":"object","properties":{"rapidOtc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"rapidHc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"tsysSierra":{"allOf":[{"type":"object","properties":{"bin":{"type":"string","nullable":true},"mid":{"type":"string","nullable":true},"mvv":{"type":"string","nullable":true},"agentBankNumber":{"type":"string","nullable":true},"agentChainNumber":{"type":"string","nullable":true},"storeNumber":{"type":"string","nullable":true},"terminalNumber":{"type":"string","nullable":true},"industryCode":{"enum":["Unknown","A","B","D","F","G","H","L","O","P","R"],"type":"string"},"currencyCode":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"cityCode":{"type":"string","nullable":true},"languageIndicator":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"mcc":{"type":"string","nullable":true},"merchantName":{"type":"string","nullable":true},"merchantLocation":{"type":"string","nullable":true},"merchantState":{"type":"string","nullable":true},"merchantLocationNumber":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"}},"additionalProperties":false}],"nullable":true},"sageAch":{"allOf":[{"type":"object","properties":{"terminals":{"type":"array","items":{"type":"object","properties":{"terminalId":{"type":"string","nullable":true},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"},"type":{"enum":["OneTime","Recurring"],"type":"string"},"dlRequired":{"type":"boolean"},"idRequired":{"type":"boolean"},"checkVerification":{"type":"boolean"},"isGatewayTerminal":{"type":"boolean"},"allowCredits":{"type":"boolean"},"checkLimit":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"hasLevel2Verification":{"type":"boolean"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"features":{"allOf":[{"type":"object","properties":{"hideInVirtualTerminal":{"type":"boolean","nullable":true},"disableAutoSettle":{"type":"boolean","nullable":true},"availableSecCodes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}],"nullable":true},"supportedPaymentMethods":{"type":"array","items":{"type":"string"},"nullable":true},"supportedCurrencies":{"type":"array","items":{"type":"string"},"nullable":true},"isDefaultCard":{"type":"boolean"},"isDefaultAch":{"type":"boolean"}},"additionalProperties":false},"nullable":true},"gatewaySettings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"preference":{"type":"array","items":{"type":"object","properties":{"metadataId":{"type":"integer","format":"int32"},"preferenceName":{"type":"string","nullable":true},"metadataName":{"type":"string","nullable":true},"metadataDisplayName":{"type":"string","nullable":true},"metadataDescription":{"type":"string","nullable":true},"metadataValue":{"type":"string","nullable":true},"metadataDataType":{"type":"string","nullable":true},"isPublic":{"type":"boolean"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "status": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            },
            "contactCompany": {
              "type": "string",
              "nullable": true
            },
            "contactName": {
              "type": "string",
              "nullable": true
            },
            "contactEmail": {
              "type": "string",
              "nullable": true
            },
            "feeScheduleId": {
              "type": "string",
              "nullable": true
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "phoneExternal": {
              "type": "string",
              "nullable": true
            },
            "receiptEmail": {
              "type": "string",
              "nullable": true
            },
            "website": {
              "type": "string",
              "nullable": true
            },
            "timezone": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "addresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isPrimary": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isInvoice": {
                    "type": "boolean"
                  },
                  "addressModel": {
                    "allOf": [
                      {
                        "required": [
                          "addressLine1",
                          "firstName"
                        ],
                        "type": "object",
                        "properties": {
                          "addressLine1": {
                            "maxLength": 50,
                            "minLength": 1,
                            "type": "string"
                          },
                          "addressLine2": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          },
                          "city": {
                            "maxLength": 40,
                            "type": "string",
                            "nullable": true
                          },
                          "state": {
                            "maxLength": 3,
                            "type": "string",
                            "nullable": true
                          },
                          "postalCode": {
                            "maxLength": 16,
                            "type": "string",
                            "nullable": true
                          },
                          "country": {
                            "maxLength": 40,
                            "type": "string",
                            "nullable": true
                          },
                          "firstName": {
                            "maxLength": 50,
                            "minLength": 1,
                            "type": "string"
                          },
                          "lastName": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          },
                          "email": {
                            "maxLength": 100,
                            "type": "string",
                            "format": "email",
                            "nullable": true
                          },
                          "phone": {
                            "maxLength": 10,
                            "pattern": "^(\\d{10})$",
                            "type": "string",
                            "nullable": true
                          },
                          "fax": {
                            "maxLength": 10,
                            "pattern": "^(\\d{10})$",
                            "type": "string",
                            "nullable": true
                          },
                          "company": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "processors": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "processorId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "processorTypeId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          },
                          "createdDateTime": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "type": {
                            "enum": [
                              "CreditCard",
                              "Ach"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "merchantId": {
                    "type": "string",
                    "nullable": true
                  },
                  "timezone": {
                    "type": "string",
                    "nullable": true
                  },
                  "hour": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "minute": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "paymentAdjustmentTypeId": {
                    "enum": [
                      "NoAdj",
                      "Flat",
                      "Percentage"
                    ],
                    "type": "string"
                  },
                  "paymentAdjustmentType": {
                    "type": "string",
                    "nullable": true
                  },
                  "paymentAdjustmentLabel": {
                    "enum": [
                      "NoLabel",
                      "ConvenienceFee",
                      "ServiceFee",
                      "AdminFee",
                      "ShippingHandlingFee"
                    ],
                    "type": "string"
                  },
                  "paymentAdjustmentValue": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "preferences": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "metadataId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "preferenceName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataValue": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDisplayName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDescription": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDataType": {
                          "type": "string",
                          "nullable": true
                        },
                        "isPublic": {
                          "type": "boolean"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "settings": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "rapidOtc": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "merchantId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "groupId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  },
                                  "did": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "visaMcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcMcc": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "rapidHc": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "merchantId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "groupId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  },
                                  "did": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "visaMcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcMcc": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "tsysSierra": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "bin": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mid": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mvv": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "agentBankNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "agentChainNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "storeNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "industryCode": {
                                    "enum": [
                                      "Unknown",
                                      "A",
                                      "B",
                                      "D",
                                      "F",
                                      "G",
                                      "H",
                                      "L",
                                      "O",
                                      "P",
                                      "R"
                                    ],
                                    "type": "string"
                                  },
                                  "currencyCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "countryCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cityCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "languageIndicator": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "timeZone": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantName": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantLocation": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantState": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantLocationNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "sageAch": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "terminals": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "terminalId": {
                                          "type": "string",
                                          "nullable": true
                                        },
                                        "secCode": {
                                          "enum": [
                                            "PPD",
                                            "CCD",
                                            "WEB",
                                            "TEL"
                                          ],
                                          "type": "string"
                                        },
                                        "type": {
                                          "enum": [
                                            "OneTime",
                                            "Recurring"
                                          ],
                                          "type": "string"
                                        },
                                        "dlRequired": {
                                          "type": "boolean"
                                        },
                                        "idRequired": {
                                          "type": "boolean"
                                        },
                                        "checkVerification": {
                                          "type": "boolean"
                                        },
                                        "isGatewayTerminal": {
                                          "type": "boolean"
                                        },
                                        "allowCredits": {
                                          "type": "boolean"
                                        },
                                        "checkLimit": {
                                          "type": "integer",
                                          "format": "int32"
                                        }
                                      },
                                      "additionalProperties": false
                                    },
                                    "nullable": true
                                  },
                                  "hasLevel2Verification": {
                                    "type": "boolean"
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "features": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "hideInVirtualTerminal": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "disableAutoSettle": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "availableSecCodes": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "supportedPaymentMethods": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "supportedCurrencies": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "isDefaultCard": {
                    "type": "boolean"
                  },
                  "isDefaultAch": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "gatewaySettings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "preference": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "metadataId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "preferenceName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDisplayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDescription": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataValue": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDataType": {
                    "type": "string",
                    "nullable": true
                  },
                  "isPublic": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadGatewayIResult
204 No Content No Content IResult
400 Bad Request Bad Request IResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden ProblemDetails
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}

PUT /api/Gateway/{gatewayId}

Body parameter

{
  "allOf": [
    {
      "required": [
        "name",
        "phone",
        "receiptEmail",
        "timezone"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 60,
          "minLength": 0,
          "pattern": "^[a-zA-Z0-9\\-&\\., ]+$",
          "type": "string"
        },
        "merchantId": {
          "maxLength": 25,
          "type": "string",
          "nullable": true
        },
        "feeScheduleId": {
          "type": "string",
          "nullable": true
        },
        "phone": {
          "maxLength": 10,
          "minLength": 1,
          "pattern": "^(\\d{10})$",
          "type": "string"
        },
        "phoneExtention": {
          "maxLength": 10,
          "type": "string",
          "nullable": true
        },
        "receiptEmail": {
          "maxLength": 100,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string"
        },
        "website": {
          "maxLength": 100,
          "type": "string",
          "nullable": true
        },
        "timezone": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "gatewayAddressId": {
                "type": "string",
                "format": "uuid",
                "nullable": true
              },
              "isPrimary": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "isInvoice": {
                "type": "boolean"
              },
              "addressModel": {
                "allOf": [
                  {
                    "required": [
                      "addressLine1",
                      "firstName"
                    ],
                    "type": "object",
                    "properties": {
                      "addressLine1": {
                        "maxLength": 50,
                        "minLength": 1,
                        "type": "string"
                      },
                      "addressLine2": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      },
                      "city": {
                        "maxLength": 40,
                        "type": "string",
                        "nullable": true
                      },
                      "state": {
                        "maxLength": 3,
                        "type": "string",
                        "nullable": true
                      },
                      "postalCode": {
                        "maxLength": 16,
                        "type": "string",
                        "nullable": true
                      },
                      "country": {
                        "maxLength": 40,
                        "type": "string",
                        "nullable": true
                      },
                      "firstName": {
                        "maxLength": 50,
                        "minLength": 1,
                        "type": "string"
                      },
                      "lastName": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      },
                      "email": {
                        "maxLength": 100,
                        "type": "string",
                        "format": "email",
                        "nullable": true
                      },
                      "phone": {
                        "maxLength": 10,
                        "pattern": "^(\\d{10})$",
                        "type": "string",
                        "nullable": true
                      },
                      "fax": {
                        "maxLength": 10,
                        "pattern": "^(\\d{10})$",
                        "type": "string",
                        "nullable": true
                      },
                      "company": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  }
                ],
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "gatewaySettings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "nullable": true
              },
              "value": {
                "type": "string",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UpdateGatewayResponseStatus
400 Bad Request Bad Request UpdateGatewayResponseStatus
401 Unauthorized Unauthorized UpdateGatewayResponseStatus
404 Not Found Not Found UpdateGatewayResponseStatus
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}

PATCH /api/Gateway/{gatewayId}

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success PatchGatewayResponseIResult
400 Bad Request Bad Request PatchGatewayResponseIResult
401 Unauthorized Unauthorized PatchGatewayResponseIResult
422 Unprocessable Entity Client Error PatchGatewayResponseIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{source}

POST /api/Gateway/{source}

Body parameter

{
  "allOf": [
    {
      "required": [
        "description",
        "name",
        "phone",
        "receiptEmail",
        "timezone"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 60,
          "minLength": 0,
          "pattern": "^[a-zA-Z0-9\\-&\\., ]+$",
          "type": "string"
        },
        "description": {
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "feeScheduleId": {
          "type": "string",
          "nullable": true
        },
        "phone": {
          "maxLength": 10,
          "minLength": 1,
          "pattern": "^(\\d{10})$",
          "type": "string"
        },
        "phoneExternal": {
          "maxLength": 16,
          "type": "string",
          "nullable": true
        },
        "receiptEmail": {
          "maxLength": 100,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string"
        },
        "website": {
          "maxLength": 100,
          "type": "string",
          "nullable": true
        },
        "timezone": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "addresses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "isPrimary": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "isInvoice": {
                "type": "boolean"
              },
              "address": {
                "allOf": [
                  {
                    "required": [
                      "addressLine1",
                      "firstName"
                    ],
                    "type": "object",
                    "properties": {
                      "addressLine1": {
                        "maxLength": 50,
                        "minLength": 1,
                        "type": "string"
                      },
                      "addressLine2": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      },
                      "city": {
                        "maxLength": 40,
                        "type": "string",
                        "nullable": true
                      },
                      "state": {
                        "maxLength": 3,
                        "type": "string",
                        "nullable": true
                      },
                      "postalCode": {
                        "maxLength": 16,
                        "type": "string",
                        "nullable": true
                      },
                      "country": {
                        "maxLength": 40,
                        "type": "string",
                        "nullable": true
                      },
                      "firstName": {
                        "maxLength": 50,
                        "minLength": 1,
                        "type": "string"
                      },
                      "lastName": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      },
                      "email": {
                        "maxLength": 100,
                        "type": "string",
                        "format": "email",
                        "nullable": true
                      },
                      "phone": {
                        "maxLength": 10,
                        "pattern": "^(\\d{10})$",
                        "type": "string",
                        "nullable": true
                      },
                      "fax": {
                        "maxLength": 10,
                        "pattern": "^(\\d{10})$",
                        "type": "string",
                        "nullable": true
                      },
                      "company": {
                        "maxLength": 50,
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  }
                ],
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "gatewaySettings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "nullable": true
              },
              "value": {
                "type": "string",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
source path string true none
api-version header string false none
body body any false none

Enumerated Values

Parameter Value
source BASYSIQ
source FP

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertGatewayResponseIResult
400 Bad Request Bad Request InsertGatewayResponseIResult
401 Unauthorized Unauthorized InsertGatewayResponseIResult
403 Forbidden Forbidden InsertGatewayResponseIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Address

POST /api/Gateway/{gatewayId}/Address

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "isInvoice": {
          "type": "boolean"
        },
        "isBilling": {
          "type": "boolean"
        },
        "isPrimary": {
          "type": "boolean"
        },
        "addressLine1": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "addressLine2": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "city": {
          "maxLength": 40,
          "type": "string",
          "nullable": true
        },
        "state": {
          "maxLength": 3,
          "type": "string",
          "nullable": true
        },
        "postalCode": {
          "maxLength": 16,
          "type": "string",
          "nullable": true
        },
        "country": {
          "maxLength": 40,
          "type": "string",
          "nullable": true
        },
        "firstName": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "lastName": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "email": {
          "maxLength": 100,
          "type": "string",
          "format": "email",
          "nullable": true
        },
        "phone": {
          "maxLength": 10,
          "pattern": "^(\\d{10})$",
          "type": "string",
          "nullable": true
        },
        "fax": {
          "maxLength": 10,
          "pattern": "^(\\d{10})$",
          "type": "string",
          "nullable": true
        },
        "company": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayAddressId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayAddressId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertGatewayAddressResponseIResult
400 Bad Request Bad Request InsertGatewayAddressResponseIResult
401 Unauthorized Unauthorized InsertGatewayAddressResponseIResult
403 Forbidden Forbidden InsertGatewayAddressResponseIResult
404 Not Found Not Found InsertGatewayAddressResponseIResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}_Configuration

PUT /api/Gateway/{gatewayId}/Configuration

Body parameter

{
  "allOf": [
    {
      "required": [
        "categoryCode",
        "fieldEntryValues"
      ],
      "type": "object",
      "properties": {
        "categoryCode": {
          "minLength": 1,
          "type": "string"
        },
        "fieldEntryValues": {
          "type": "array",
          "items": {
            "required": [
              "fieldCode",
              "fieldValue"
            ],
            "type": "object",
            "properties": {
              "fieldCode": {
                "minLength": 1,
                "type": "string"
              },
              "fieldValue": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UpdateGatewayConfigurationResponseIResult
400 Bad Request Bad Request IResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}_Configuration

GET /api/Gateway/{gatewayId}/Configuration

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"displayName":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"orderNumber":{"type":"integer","format":"int32"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"orderNumber":{"type":"integer","format":"int32"},"fields":{"type":"array","items":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid"},"groupId":{"type":"integer","format":"int32"},"label":{"type":"string","nullable":true},"code":{"type":"string","nullable":true},"adornmentLabel":{"type":"string","nullable":true},"type":{"enum":["Text","Radio","Checklist","Select","Multiselect","Switch"],"type":"string"},"dataType":{"type":"string","nullable":true},"orderNumber":{"type":"integer","format":"int32"},"isRequired":{"type":"boolean"},"value":{"type":"string","nullable":true},"options":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "categories": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "orderNumber": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "groups": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "name": {
                          "type": "string",
                          "nullable": true
                        },
                        "orderNumber": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "fields": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "categoryId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "groupId": {
                                "type": "integer",
                                "format": "int32"
                              },
                              "label": {
                                "type": "string",
                                "nullable": true
                              },
                              "code": {
                                "type": "string",
                                "nullable": true
                              },
                              "adornmentLabel": {
                                "type": "string",
                                "nullable": true
                              },
                              "type": {
                                "enum": [
                                  "Text",
                                  "Radio",
                                  "Checklist",
                                  "Select",
                                  "Multiselect",
                                  "Switch"
                                ],
                                "type": "string"
                              },
                              "dataType": {
                                "type": "string",
                                "nullable": true
                              },
                              "orderNumber": {
                                "type": "integer",
                                "format": "int32"
                              },
                              "isRequired": {
                                "type": "boolean"
                              },
                              "value": {
                                "type": "string",
                                "nullable": true
                              },
                              "options": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "label": {
                                      "type": "string",
                                      "nullable": true
                                    },
                                    "value": {
                                      "type": "string",
                                      "nullable": true
                                    }
                                  },
                                  "additionalProperties": false
                                },
                                "nullable": true
                              }
                            },
                            "additionalProperties": false
                          },
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GatewayConfigurationModelIResult
400 Bad Request Bad Request IResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden IResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}Status{status}

PUT /api/Gateway/{gatewayId}/Status/{status}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
status path string true none
api-version header string false none

Enumerated Values

Parameter Value
status Active
status Disabled

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success StatusGatewayResponseIResult
400 Bad Request Bad Request StatusGatewayResponseIResult
401 Unauthorized Unauthorized StatusGatewayResponseIResult
403 Forbidden Forbidden StatusGatewayResponseIResult
404 Not Found Not Found StatusGatewayResponseIResult
500 Internal Server Error Server Error ObjectIResult

GatewayUser

post_api_Gateway{gatewayId}_User

POST /api/Gateway/{gatewayId}/User

Body parameter

{
  "allOf": [
    {
      "required": [
        "email",
        "firstName",
        "lastName",
        "phone",
        "roleId"
      ],
      "type": "object",
      "properties": {
        "email": {
          "maxLength": 100,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string"
        },
        "firstName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "lastName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "phone": {
          "maxLength": 10,
          "minLength": 0,
          "pattern": "^(\\d{10})$",
          "type": "string"
        },
        "roleId": {
          "type": "string",
          "format": "uuid"
        },
        "permissionIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            },
            "userId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertGatewayUserResponseModelIResult
207 Multi-Status Success InsertGatewayUserResponseModelIResult
400 Bad Request Bad Request InsertGatewayUserResponseModelIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden InsertGatewayUserResponseModelIResult
409 Conflict Conflict InsertGatewayUserResponseModelIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}_User

GET /api/Gateway/{gatewayId}/User

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
Offset query integer(int32) false none
Limit query integer(int32) false none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayUserId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GatewayUserDetailsBaseModelPagedResultIResult
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden ProblemDetails
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}User{gatewayUserId}

DELETE /api/Gateway/{gatewayId}/User/{gatewayUserId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
isSystemUserId query boolean false none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}User{gatewayUserId}

PUT /api/Gateway/{gatewayId}/User/{gatewayUserId}

Body parameter

{
  "allOf": [
    {
      "required": [
        "firstName",
        "gatewayUserStatus",
        "lastName",
        "phone",
        "roleId",
        "userStatus"
      ],
      "type": "object",
      "properties": {
        "firstName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "lastName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "phone": {
          "maxLength": 10,
          "minLength": 1,
          "pattern": "^(\\d{10})$",
          "type": "string"
        },
        "userStatus": {
          "enum": [
            "InvitePending",
            "PendingTOS",
            "Active",
            "Disabled"
          ],
          "type": "string"
        },
        "gatewayUserStatus": {
          "enum": [
            "Active",
            "Disabled"
          ],
          "type": "string"
        },
        "roleId": {
          "type": "string",
          "format": "uuid"
        },
        "permissionIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
isSystemUserId query boolean false none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GatewayUserDetailsBaseModelIResult
400 Bad Request Bad Request GatewayUserDetailsBaseModelIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden GatewayUserDetailsBaseModelIResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}User{gatewayUserId}

GET /api/Gateway/{gatewayId}/User/{gatewayUserId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
isSystemUserId query boolean false none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"},"phone":{"type":"string","nullable":true},"gatewayUserStatus":{"enum":["Active","Disabled"],"type":"string"},"user":{"allOf":[{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"email":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"userPermissions":{"type":"array","items":{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"userRole":{"enum":["SU","SA","GA","GS"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"role":{"allOf":[{"type":"object","properties":{"roleId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"isGatewayRole":{"type":"boolean"}},"additionalProperties":false}],"nullable":true},"gatewayUserPermissions":{"type":"array","items":{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "gatewayUserStatus": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "user": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "userId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "email": {
                      "type": "string",
                      "nullable": true
                    },
                    "firstName": {
                      "type": "string",
                      "nullable": true
                    },
                    "lastName": {
                      "type": "string",
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdDateTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "userPermissions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "permissionId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "code": {
                            "type": "string",
                            "nullable": true
                          },
                          "description": {
                            "type": "string",
                            "nullable": true
                          },
                          "order": {
                            "type": "integer",
                            "format": "int32"
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    },
                    "userRole": {
                      "enum": [
                        "SU",
                        "SA",
                        "GA",
                        "GS"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "role": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "roleId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "code": {
                      "type": "string",
                      "nullable": true
                    },
                    "description": {
                      "type": "string",
                      "nullable": true
                    },
                    "isGatewayRole": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "gatewayUserPermissions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "permissionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "order": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseGatewayUserDetailIResult
204 No Content No Content IResult
400 Bad Request Bad Request ResponseGatewayUserDetailIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden ProblemDetails
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_User_validate

POST /api/Gateway/{gatewayId}/User/validate

Body parameter

{
  "allOf": [
    {
      "required": [
        "email"
      ],
      "type": "object",
      "properties": {
        "email": {
          "maxLength": 100,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"isCreateAllowed":{"type":"boolean"},"accountExists":{"type":"boolean"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "isCreateAllowed": {
              "type": "boolean"
            },
            "accountExists": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ValidateCreateGatewayUserResponseIResult
400 Bad Request Bad Request ValidateCreateGatewayUserResponseIResult
401 Unauthorized Unauthorized ValidateCreateGatewayUserResponseIResult
403 Forbidden Forbidden ValidateCreateGatewayUserResponseIResult
500 Internal Server Error Server Error ObjectIResult

Invoice

post_api_Gateway{gatewayId}_Invoice

POST /api/Gateway/{gatewayId}/Invoice

Body parameter

{
  "allOf": [
    {
      "required": [
        "dueDate",
        "invoiceAddresses",
        "invoiceDate",
        "invoicePaymentMethod",
        "invoiceStatusId",
        "invoiceTypeId",
        "lineItems",
        "requireBillingInfo",
        "requireShippingInfo",
        "title",
        "vaultCustomer"
      ],
      "type": "object",
      "properties": {
        "customerId": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "title": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "number": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "message": {
          "maxLength": 500,
          "type": "string",
          "nullable": true
        },
        "invoiceStatusId": {
          "type": "integer",
          "format": "int32"
        },
        "invoiceTypeId": {
          "type": "integer",
          "format": "int32"
        },
        "requireShippingInfo": {
          "type": "boolean"
        },
        "requireBillingInfo": {
          "type": "boolean"
        },
        "vaultCustomer": {
          "type": "boolean"
        },
        "invoiceDate": {
          "type": "string",
          "format": "date-time"
        },
        "dueDate": {
          "type": "string",
          "format": "date-time"
        },
        "invoicePaymentMethod": {
          "allOf": [
            {
              "required": [
                "ach",
                "card"
              ],
              "type": "object",
              "properties": {
                "cardProcessorId": {
                  "type": "string",
                  "format": "uuid",
                  "nullable": true
                },
                "achProcessorId": {
                  "type": "string",
                  "format": "uuid",
                  "nullable": true
                },
                "secCode": {
                  "enum": [
                    "PPD",
                    "CCD",
                    "WEB",
                    "TEL"
                  ],
                  "type": "string",
                  "nullable": true
                },
                "card": {
                  "type": "boolean"
                },
                "ach": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "invoiceAddresses": {
          "maxItems": 3,
          "type": "array",
          "items": {
            "required": [
              "isBilling",
              "isRemittance",
              "isShipping"
            ],
            "type": "object",
            "properties": {
              "isRemittance": {
                "type": "boolean"
              },
              "isShipping": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "firstName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "lastName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "company": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "email": {
                "maxLength": 100,
                "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
                "type": "string",
                "nullable": true
              },
              "phone": {
                "maxLength": 15,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "fax": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "addressLine1": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "addressLine2": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "city": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              },
              "state": {
                "maxLength": 3,
                "type": "string",
                "nullable": true
              },
              "postalCode": {
                "maxLength": 10,
                "type": "string",
                "nullable": true
              },
              "country": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              }
            },
            "additionalProperties": false
          }
        },
        "invoiceNotifications": {
          "type": "array",
          "items": {
            "required": [
              "bcc",
              "cc",
              "invoiceNotificationMethodId",
              "mainRecipient"
            ],
            "type": "object",
            "properties": {
              "invoiceNotificationMethodId": {
                "type": "integer",
                "format": "int32"
              },
              "mainRecipient": {
                "maxLength": 100,
                "minLength": 1,
                "type": "string"
              },
              "cc": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "bcc": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "lineItems": {
          "type": "array",
          "items": {
            "required": [
              "description",
              "discount",
              "isTaxable",
              "localTaxPercent",
              "name",
              "nationalTaxPercent",
              "quantity",
              "unitPrice"
            ],
            "type": "object",
            "properties": {
              "name": {
                "maxLength": 50,
                "minLength": 1,
                "type": "string"
              },
              "description": {
                "maxLength": 100,
                "minLength": 1,
                "type": "string"
              },
              "quantity": {
                "type": "integer",
                "format": "int32"
              },
              "unitPrice": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double"
              },
              "discount": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double"
              },
              "shippedAmount": {
                "type": "number",
                "format": "double",
                "nullable": true
              },
              "freightAmount": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double",
                "nullable": true
              },
              "unitOfMeasureId": {
                "type": "integer",
                "format": "int32",
                "nullable": true
              },
              "isTaxable": {
                "type": "boolean"
              },
              "localTaxPercent": {
                "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                "type": "number",
                "format": "double"
              },
              "nationalTaxPercent": {
                "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                "type": "number",
                "format": "double"
              }
            },
            "additionalProperties": false
          }
        },
        "customFields": {
          "type": "array",
          "items": {
            "required": [
              "customFieldId",
              "customFieldValue"
            ],
            "type": "object",
            "properties": {
              "customFieldId": {
                "type": "integer",
                "format": "int32"
              },
              "customFieldValue": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created ResponseInsertInvoiceIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ResponseInsertInvoiceIResult
403 Forbidden Forbidden ResponseInsertInvoiceIResult
404 Not Found Not Found ResponseInsertInvoiceIResult
500 Internal Server Error Server Error ObjectIResult

patch_api_Gateway{gatewayId}_Invoice

PATCH /api/Gateway/{gatewayId}/Invoice

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

400 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}Invoice{invoiceId}

GET /api/Gateway/{gatewayId}/Invoice/{invoiceId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
invoiceId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"invoiceStatus":{"allOf":[{"type":"object","properties":{"invoiceStatusId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"invoiceType":{"allOf":[{"type":"object","properties":{"invoiceTypeId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"amountCaptured":{"type":"number","format":"double"},"remainingBalance":{"type":"number","format":"double"},"subtotal":{"type":"number","format":"double"},"shipping":{"type":"number","format":"double","nullable":true},"total":{"type":"number","format":"double"},"tax":{"type":"number","format":"double"},"fees":{"type":"number","format":"double","nullable":true},"discounts":{"type":"number","format":"double","nullable":true},"requireShippingInfo":{"type":"boolean"},"requireBillingInfo":{"type":"boolean"},"invoiceDate":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"createdByUserId":{"type":"string","format":"uuid"},"createdDateTime":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","nullable":true},"revisionNumber":{"type":"integer","format":"int32"},"gateway":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"customer":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"invoicePaymentMethod":{"allOf":[{"type":"object","properties":{"invoicePaymentMethodId":{"type":"string","format":"uuid"},"cardProcessorId":{"type":"string","format":"uuid","nullable":true},"achProcessorId":{"type":"string","format":"uuid","nullable":true},"secCode":{"type":"integer","format":"int32","nullable":true},"card":{"type":"boolean"},"ach":{"type":"boolean"}},"additionalProperties":false}],"nullable":true},"lineItems":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"integer","format":"int32"},"unitPrice":{"type":"number","format":"double"},"discount":{"type":"number","format":"double"},"shippedAmount":{"type":"number","format":"double","nullable":true},"freightAmount":{"type":"number","format":"double","nullable":true},"unitOfMeasure":{"allOf":[{"type":"object","properties":{"unitOfMeasureId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"isTaxable":{"type":"boolean"},"localTaxPercent":{"type":"number","format":"double"},"nationalTaxPercent":{"type":"number","format":"double"}},"additionalProperties":false},"nullable":true},"invoiceAddresses":{"type":"array","items":{"type":"object","properties":{"invoiceAddressId":{"type":"string","format":"uuid"},"addressId":{"type":"string","format":"uuid"},"isShipping":{"type":"boolean"},"isBilling":{"type":"boolean"},"isRemittance":{"type":"boolean"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"invoiceNotifications":{"type":"array","items":{"type":"object","properties":{"invoiceNotificationGroupId":{"type":"string","format":"uuid"},"notificationMethod":{"allOf":[{"type":"object","properties":{"invoiceNotificationMethodId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"notificationStatus":{"allOf":[{"type":"object","properties":{"invoiceNotificationStatusId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"notificationEventType":{"allOf":[{"type":"object","properties":{"invoiceNotificationEventTypeId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"mainRecipient":{"type":"string","nullable":true},"cc":{"type":"array","items":{"type":"string"},"nullable":true},"bcc":{"type":"array","items":{"type":"string"},"nullable":true},"deliveryDateTime":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"customFieldEntries":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"customFieldCategoryName":{"type":"string","nullable":true},"customFieldCategoryId":{"type":"integer","format":"int32"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"transactionType":{"enum":["Sale","Authorize","Capture","Credit","Refund","Verification"],"type":"string"},"paymentType":{"enum":["Card","Ach","Token","Terminal"],"type":"string"},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string"},"remit":{"allOf":[{"type":"object","properties":{"settledAmount":{"type":"number","format":"double"},"capturedAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"authorizedAmount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"surchargeAmount":{"type":"number","format":"double"},"paymentAdjustmentAmount":{"type":"number","format":"double"},"paymentAdjustmentType":{"enum":["NoAdj","Flat","Percentage"],"type":"string"},"ach":{"allOf":[{"type":"object","properties":{"maskedAccount":{"type":"string","nullable":true},"accountType":{"enum":["Checking","Savings"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"card":{"allOf":[{"type":"object","properties":{"maskedCard":{"type":"string","nullable":true},"cardType":{"enum":["Visa","MasterCard","Discover","AmericanExpress"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"settledDateTime":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"createdDateTime":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            },
            "title": {
              "type": "string",
              "nullable": true
            },
            "number": {
              "type": "string",
              "nullable": true
            },
            "invoiceStatus": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceStatusId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoiceType": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceTypeId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "amountCaptured": {
              "type": "number",
              "format": "double"
            },
            "remainingBalance": {
              "type": "number",
              "format": "double"
            },
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "fees": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "discounts": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "requireShippingInfo": {
              "type": "boolean"
            },
            "requireBillingInfo": {
              "type": "boolean"
            },
            "invoiceDate": {
              "type": "string",
              "nullable": true
            },
            "dueDate": {
              "type": "string",
              "nullable": true
            },
            "message": {
              "type": "string",
              "nullable": true
            },
            "createdByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "createdDateTime": {
              "type": "string",
              "nullable": true
            },
            "modifiedByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "modifiedDateTime": {
              "type": "string",
              "nullable": true
            },
            "revisionNumber": {
              "type": "integer",
              "format": "int32"
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoicePaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoicePaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "cardProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "achProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "secCode": {
                      "type": "integer",
                      "format": "int32",
                      "nullable": true
                    },
                    "card": {
                      "type": "boolean"
                    },
                    "ach": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "lineItemId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "quantity": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "discount": {
                    "type": "number",
                    "format": "double"
                  },
                  "shippedAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "freightAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isTaxable": {
                    "type": "boolean"
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double"
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isRemittance": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceNotifications": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceNotificationGroupId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "notificationMethod": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationMethodId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "notificationStatus": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationStatusId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "notificationEventType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationEventTypeId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "mainRecipient": {
                    "type": "string",
                    "nullable": true
                  },
                  "cc": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "bcc": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "deliveryDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "transactions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "transactionType": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentType": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "remit": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "settledAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "capturedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "baseAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "authorizedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "taxAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "surchargeAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentType": {
                            "enum": [
                              "NoAdj",
                              "Flat",
                              "Percentage"
                            ],
                            "type": "string"
                          },
                          "ach": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedAccount": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "accountType": {
                                    "enum": [
                                      "Checking",
                                      "Savings"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "card": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedCard": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cardType": {
                                    "enum": [
                                      "Visa",
                                      "MasterCard",
                                      "Discover",
                                      "AmericanExpress"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "settledDateTime": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadInvoiceIResult
204 No Content No Content ResponseReadInvoiceIResult
400 Bad Request Bad Request ResponseReadInvoiceIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponseReadInvoiceIResult
404 Not Found Not Found ResponseReadInvoiceIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Invoice{invoiceId}

DELETE /api/Gateway/{gatewayId}/Invoice/{invoiceId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
invoiceId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content ObjectIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ObjectIResult
404 Not Found Not Found ObjectIResult
409 Conflict Conflict ObjectIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Invoice_CalculateFees

POST /api/Gateway/{gatewayId}/Invoice/CalculateFees

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "lineItems": {
          "type": "array",
          "items": {
            "required": [
              "discount",
              "quantity",
              "unitPrice"
            ],
            "type": "object",
            "properties": {
              "quantity": {
                "type": "integer",
                "format": "int32"
              },
              "unitPrice": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double"
              },
              "discount": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double"
              },
              "freightAmount": {
                "pattern": "^\\d+(\\.\\d{1,2})?$",
                "type": "number",
                "format": "double",
                "nullable": true
              },
              "localTaxPercent": {
                "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                "type": "number",
                "format": "double",
                "nullable": true
              },
              "nationalTaxPercent": {
                "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                "type": "number",
                "format": "double",
                "nullable": true
              },
              "isTaxable": {
                "type": "boolean",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "shippingState": {
          "maxLength": 3,
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"subtotal":{"type":"number","format":"double"},"discounts":{"type":"number","format":"double"},"tax":{"type":"number","format":"double"},"total":{"type":"number","format":"double"},"shipping":{"allOf":[{"type":"object","properties":{"amount":{"type":"number","format":"double"},"taxPlacement":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "discounts": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "taxPlacement": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseInvoiceFeesIResult
400 Bad Request Bad Request ResponseInvoiceFeesIResult
401 Unauthorized Unauthorized ResponseInvoiceFeesIResult
403 Forbidden Forbidden ResponseInvoiceFeesIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}Invoice{invoiceId}_PDF

GET /api/Gateway/{gatewayId}/Invoice/{invoiceId}/PDF

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
invoiceId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"string","format":"byte","nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ByteArrayIResult
400 Bad Request Bad Request ByteArrayIResult
401 Unauthorized Unauthorized ByteArrayIResult
403 Forbidden Forbidden ByteArrayIResult
404 Not Found Not Found ByteArrayIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Invoice_Search

POST /api/Gateway/{gatewayId}/Invoice/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "globalSearch": {
          "maxLength": 100,
          "type": "string",
          "nullable": true
        },
        "invoiceId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "title": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "number": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "status": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "type": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountCaptured": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "remainingBalance": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "subtotal": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shipping": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "total": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "fees": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "discounts": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "tax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "invoiceDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "dueDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "modifiedDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFirstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingLastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCity": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCountry": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingState": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPostalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPhone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "maximum": 2147483647,
          "minimum": 0,
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "maximum": 100,
          "minimum": 0,
          "type": "integer",
          "format": "int32"
        },
        "sortColumn": {
          "pattern": "^(CreatedDateTime|DueDate|Status|CapturedAmount|RemainingBalance|InvoiceId|CustomerName|Discounts|Fees)$",
          "type": "string",
          "nullable": true
        },
        "sortDirection": {
          "pattern": "^(ASC|DESC)$",
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"gatewayId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"customer":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"invoiceStatus":{"allOf":[{"type":"object","properties":{"invoiceStatusId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"invoiceType":{"allOf":[{"type":"object","properties":{"invoiceTypeId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"amountCaptured":{"type":"number","format":"double"},"remainingBalance":{"type":"number","format":"double"},"subtotal":{"type":"number","format":"double"},"shipping":{"type":"number","format":"double","nullable":true},"total":{"type":"number","format":"double"},"fees":{"type":"number","format":"double","nullable":true},"discounts":{"type":"number","format":"double","nullable":true},"tax":{"type":"number","format":"double","nullable":true},"transactionIds":{"type":"array","items":{"type":"string","format":"uuid"},"nullable":true},"invoiceDate":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"createdByUserId":{"type":"string","format":"uuid"},"createdDateTime":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "title": {
                    "type": "string",
                    "nullable": true
                  },
                  "number": {
                    "type": "string",
                    "nullable": true
                  },
                  "customer": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "customerId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "invoiceStatus": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceStatusId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "invoiceType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceTypeId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "amountCaptured": {
                    "type": "number",
                    "format": "double"
                  },
                  "remainingBalance": {
                    "type": "number",
                    "format": "double"
                  },
                  "subtotal": {
                    "type": "number",
                    "format": "double"
                  },
                  "shipping": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "total": {
                    "type": "number",
                    "format": "double"
                  },
                  "fees": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "discounts": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "tax": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "transactionIds": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "nullable": true
                  },
                  "invoiceDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "dueDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseSearchInvoicePagedResultStatus
204 No Content No Content ResponseSearchInvoicePagedResultStatus
400 Bad Request Bad Request ResponseSearchInvoicePagedResultStatus
401 Unauthorized Unauthorized ResponseSearchInvoicePagedResultStatus
403 Forbidden Forbidden ResponseSearchInvoicePagedResultStatus
500 Internal Server Error Server Error ObjectIResult

OpenEndpoint

get_api_Invoice{invoiceToken}

GET /api/Invoice/{invoiceToken}

Parameters

Name In Type Required Description
invoiceToken path string true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"title":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"invoiceStatus":{"allOf":[{"type":"object","properties":{"invoiceStatusId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"remainingBalance":{"type":"number","format":"double"},"capturedAmount":{"type":"number","format":"double"},"subtotal":{"type":"number","format":"double"},"shipping":{"type":"number","format":"double","nullable":true},"total":{"type":"number","format":"double"},"tax":{"type":"number","format":"double"},"fees":{"type":"number","format":"double","nullable":true},"discounts":{"type":"number","format":"double","nullable":true},"requireShippingInfo":{"type":"boolean"},"requireBillingInfo":{"type":"boolean"},"invoiceDate":{"type":"string","nullable":true},"dueDate":{"type":"string","nullable":true},"message":{"type":"string","nullable":true},"surcharge":{"type":"boolean"},"surchargePercentage":{"type":"number","format":"double"},"gateway":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"customer":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"invoicePaymentMethod":{"allOf":[{"type":"object","properties":{"invoicePaymentMethodId":{"type":"string","format":"uuid"},"cardProcessorId":{"type":"string","format":"uuid","nullable":true},"achProcessorId":{"type":"string","format":"uuid","nullable":true},"secCode":{"type":"integer","format":"int32","nullable":true},"card":{"type":"boolean"},"ach":{"type":"boolean"}},"additionalProperties":false}],"nullable":true},"transactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"transactionType":{"enum":["Sale","Authorize","Capture","Credit","Refund","Verification"],"type":"string"},"paymentType":{"enum":["Card","Ach","Token","Terminal"],"type":"string"},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string"},"remit":{"allOf":[{"type":"object","properties":{"settledAmount":{"type":"number","format":"double"},"capturedAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"authorizedAmount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"surchargeAmount":{"type":"number","format":"double"},"paymentAdjustmentAmount":{"type":"number","format":"double"},"paymentAdjustmentType":{"enum":["NoAdj","Flat","Percentage"],"type":"string"},"ach":{"allOf":[{"type":"object","properties":{"maskedAccount":{"type":"string","nullable":true},"accountType":{"enum":["Checking","Savings"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"card":{"allOf":[{"type":"object","properties":{"maskedCard":{"type":"string","nullable":true},"cardType":{"enum":["Visa","MasterCard","Discover","AmericanExpress"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"settledDateTime":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"createdDateTime":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"lineItems":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"integer","format":"int32"},"unitPrice":{"type":"number","format":"double"},"discount":{"type":"number","format":"double"},"shippedAmount":{"type":"number","format":"double","nullable":true},"freightAmount":{"type":"number","format":"double","nullable":true},"unitOfMeasure":{"allOf":[{"type":"object","properties":{"unitOfMeasureId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"isTaxable":{"type":"boolean"},"localTaxPercent":{"type":"number","format":"double"},"nationalTaxPercent":{"type":"number","format":"double"}},"additionalProperties":false},"nullable":true},"invoiceAddresses":{"type":"array","items":{"type":"object","properties":{"invoiceAddressId":{"type":"string","format":"uuid"},"addressId":{"type":"string","format":"uuid"},"isShipping":{"type":"boolean"},"isBilling":{"type":"boolean"},"isRemittance":{"type":"boolean"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            },
            "title": {
              "type": "string",
              "nullable": true
            },
            "number": {
              "type": "string",
              "nullable": true
            },
            "invoiceStatus": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceStatusId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double"
            },
            "capturedAmount": {
              "type": "number",
              "format": "double"
            },
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "fees": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "discounts": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "requireShippingInfo": {
              "type": "boolean"
            },
            "requireBillingInfo": {
              "type": "boolean"
            },
            "invoiceDate": {
              "type": "string",
              "nullable": true
            },
            "dueDate": {
              "type": "string",
              "nullable": true
            },
            "message": {
              "type": "string",
              "nullable": true
            },
            "surcharge": {
              "type": "boolean"
            },
            "surchargePercentage": {
              "type": "number",
              "format": "double"
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoicePaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoicePaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "cardProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "achProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "secCode": {
                      "type": "integer",
                      "format": "int32",
                      "nullable": true
                    },
                    "card": {
                      "type": "boolean"
                    },
                    "ach": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "transactionType": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentType": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "remit": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "settledAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "capturedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "baseAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "authorizedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "taxAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "surchargeAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentType": {
                            "enum": [
                              "NoAdj",
                              "Flat",
                              "Percentage"
                            ],
                            "type": "string"
                          },
                          "ach": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedAccount": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "accountType": {
                                    "enum": [
                                      "Checking",
                                      "Savings"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "card": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedCard": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cardType": {
                                    "enum": [
                                      "Visa",
                                      "MasterCard",
                                      "Discover",
                                      "AmericanExpress"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "settledDateTime": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "lineItemId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "quantity": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "discount": {
                    "type": "number",
                    "format": "double"
                  },
                  "shippedAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "freightAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isTaxable": {
                    "type": "boolean"
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double"
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isRemittance": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadInvoiceByTokenIResult
400 Bad Request Bad Request ResponseReadInvoiceByTokenIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponseReadInvoiceByTokenIResult
404 Not Found Not Found ResponseReadInvoiceByTokenIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Invoice{invoiceToken}_Transaction

POST /api/Invoice/{invoiceToken}/Transaction

Body parameter

{
  "allOf": [
    {
      "required": [
        "transactionPaymentMethod",
        "transactionRemit"
      ],
      "type": "object",
      "properties": {
        "description": {
          "maxLength": 255,
          "type": "string",
          "nullable": true
        },
        "transactionPaymentMethod": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "card": {
                  "allOf": [
                    {
                      "required": [
                        "cardToken",
                        "maskedNumber"
                      ],
                      "type": "object",
                      "properties": {
                        "cardToken": {
                          "maxLength": 50,
                          "minLength": 1,
                          "type": "string"
                        },
                        "cardType": {
                          "enum": [
                            "Visa",
                            "MasterCard",
                            "Discover",
                            "AmericanExpress"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "expirationDate": {
                          "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                          "type": "string",
                          "nullable": true
                        },
                        "maskedNumber": {
                          "minLength": 1,
                          "pattern": "^\\d{6}\\*{6,}\\d{4}$",
                          "type": "string"
                        },
                        "entryType": {
                          "enum": [
                            "Swiped",
                            "Keyed",
                            "Contact",
                            "Contactless"
                          ],
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "ach": {
                  "allOf": [
                    {
                      "required": [
                        "achToken"
                      ],
                      "type": "object",
                      "properties": {
                        "achToken": {
                          "maxLength": 50,
                          "minLength": 1,
                          "type": "string"
                        },
                        "secCode": {
                          "enum": [
                            "PPD",
                            "CCD",
                            "WEB",
                            "TEL"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "routingNumber": {
                          "type": "string",
                          "nullable": true
                        },
                        "accountType": {
                          "enum": [
                            "Checking",
                            "Savings"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "checkNumber": {
                          "type": "string",
                          "nullable": true
                        },
                        "accountHolderAuth": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "dlState": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "dlNumber": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "transactionRemit": {
          "allOf": [
            {
              "required": [
                "baseAmount",
                "currencyCode"
              ],
              "type": "object",
              "properties": {
                "baseAmount": {
                  "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                  "type": "number",
                  "format": "double"
                },
                "currencyCode": {
                  "enum": [
                    "USD"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "transactionAddress": {
          "type": "array",
          "items": {
            "required": [
              "isBilling",
              "isPhysical",
              "isShipping"
            ],
            "type": "object",
            "properties": {
              "isPhysical": {
                "type": "boolean"
              },
              "isShipping": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "firstName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "lastName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "company": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "email": {
                "maxLength": 100,
                "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
                "type": "string",
                "nullable": true
              },
              "phone": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "fax": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "addressLine1": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "addressLine2": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "city": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              },
              "state": {
                "maxLength": 3,
                "type": "string",
                "nullable": true
              },
              "postalCode": {
                "maxLength": 10,
                "type": "string",
                "nullable": true
              },
              "country": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "emailReceipt": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
invoiceToken path string true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string","nullable":true},"response":{"type":"string","nullable":true},"responseCode":{"type":"integer","format":"int32","nullable":true},"appliedToBalanceAmount":{"type":"number","format":"double","nullable":true},"remainingBalance":{"type":"number","format":"double","nullable":true},"transactionTotal":{"type":"number","format":"double","nullable":true},"cardPresentResponse":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"dataWireId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"cardBrand":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"expireDate":{"type":"string","nullable":true},"transaction":{"allOf":[{"type":"object","properties":{"transactionType":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"referenceNumber":{"type":"string","nullable":true},"referenceIsoDateTime":{"type":"string","format":"date-time"},"stan":{"type":"string","nullable":true},"responseCode":{"enum":["UNKN","DECL","APPR"],"type":"string","nullable":true},"responseReason":{"type":"string","nullable":true},"cardResponse":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"completionRequired":{"type":"boolean","nullable":true},"approvedAmount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ProcessTransactionResponseIResult
207 Multi-Status Success ProcessTransactionResponseIResult
400 Bad Request Bad Request ProcessTransactionResponseIResult
401 Unauthorized Unauthorized ProcessTransactionResponseIResult
403 Forbidden Forbidden ProcessTransactionResponseIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Invoice{invoiceToken}_Tokenization_Configuration

GET /api/Invoice/{invoiceToken}/Tokenization/Configuration

Parameters

Name In Type Required Description
invoiceToken path string true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"cardTokenizer":{"type":"string","nullable":true},"achTokenizer":{"type":"string","nullable":true},"iframeConfiguration":{"allOf":[{"type":"object","properties":{"iqPro":{"allOf":[{"type":"object","properties":{"publicKey":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"iqProV2":{"allOf":[{"type":"object","properties":{"origin":{"type":"string","nullable":true},"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"proxyConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"tokenizationId":{"type":"string","nullable":true},"profiles":{"type":"array","items":{"type":"object","properties":{"profileName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"profileKey":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"achConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"achUrl":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"apiConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"mobileConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cardTokenizer": {
              "type": "string",
              "nullable": true
            },
            "achTokenizer": {
              "type": "string",
              "nullable": true
            },
            "iframeConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqPro": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "publicKey": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "origin": {
                              "type": "string",
                              "nullable": true
                            },
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "proxyConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "profiles": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "profileName": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "url": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "profileKey": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              },
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "achConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "achUrl": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "apiConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "mobileConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ReadTokenizationConfigurationIResult
400 Bad Request Bad Request ReadTokenizationConfigurationIResult
401 Unauthorized Unauthorized ReadTokenizationConfigurationIResult
403 Forbidden Forbidden ReadTokenizationConfigurationIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Invoice{invoiceToken}_PDF

GET /api/Invoice/{invoiceToken}/PDF

Parameters

Name In Type Required Description
invoiceToken path string true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"string","format":"byte","nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ByteArrayIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ByteArrayIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Invoice{invoiceToken}_Transaction_CalculateFees

POST /api/Invoice/{invoiceToken}/Transaction/CalculateFees

Body parameter

{
  "allOf": [
    {
      "required": [
        "addTaxToTotal",
        "baseAmount",
        "creditCardBin",
        "processorId"
      ],
      "type": "object",
      "properties": {
        "creditCardBin": {
          "maxLength": 6,
          "minLength": 0,
          "pattern": "^[0-9]*$",
          "type": "string"
        },
        "state": {
          "maxLength": 3,
          "type": "string",
          "nullable": true
        },
        "baseAmount": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "paymentAdjustmentType": {
          "enum": [
            "NoAdj",
            "Flat",
            "Percentage"
          ],
          "type": "string",
          "nullable": true
        },
        "paymentAdjustmentValue": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double",
          "nullable": true
        },
        "addTaxToTotal": {
          "type": "boolean"
        },
        "taxAmount": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "processorId": {
          "type": "string",
          "format": "uuid"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
invoiceToken path string true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"isSurchargeable":{"type":"boolean"},"surchargeAmount":{"type":"number","format":"double"},"serviceFeesAmount":{"type":"number","format":"double"},"convenienceFeesAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"amount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"cardBrand":{"type":"string","nullable":true},"cardType":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "isSurchargeable": {
            "type": "boolean"
          },
          "surchargeAmount": {
            "type": "number",
            "format": "double"
          },
          "serviceFeesAmount": {
            "type": "number",
            "format": "double"
          },
          "convenienceFeesAmount": {
            "type": "number",
            "format": "double"
          },
          "baseAmount": {
            "type": "number",
            "format": "double"
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "taxAmount": {
            "type": "number",
            "format": "double"
          },
          "cardBrand": {
            "type": "string",
            "nullable": true
          },
          "cardType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success TransactionFeesResponseModelListStatus
400 Bad Request Bad Request TransactionFeesResponseModelListStatus
401 Unauthorized Unauthorized TransactionFeesResponseModelListStatus
403 Forbidden Forbidden TransactionFeesResponseModelListStatus
500 Internal Server Error Server Error ObjectIResult

Processor

get_api_Gateway{gatewayId}_Processor

GET /api/Gateway/{gatewayId}/Processor

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true},"processorId":{"type":"string","format":"uuid"},"processorType":{"allOf":[{"type":"object","properties":{"processorTypeId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"type":{"enum":["CreditCard","Ach"],"type":"string"}},"additionalProperties":false}],"nullable":true},"merchantId":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"paymentAdjustmentTypeId":{"enum":["NoAdj","Flat","Percentage"],"type":"string"},"paymentAdjustmentType":{"type":"string","nullable":true},"paymentAdjustmentLabel":{"enum":["NoLabel","ConvenienceFee","ServiceFee","AdminFee","ShippingHandlingFee"],"type":"string"},"paymentAdjustmentValue":{"type":"number","format":"double","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"preferences":{"type":"array","items":{"type":"object","properties":{"metadataId":{"type":"integer","format":"int32"},"preferenceName":{"type":"string","nullable":true},"metadataName":{"type":"string","nullable":true},"metadataValue":{"type":"string","nullable":true},"metadataDisplayName":{"type":"string","nullable":true},"metadataDescription":{"type":"string","nullable":true},"metadataDataType":{"type":"string","nullable":true},"isPublic":{"type":"boolean"}},"additionalProperties":false},"nullable":true},"settings":{"allOf":[{"type":"object","properties":{"rapidOtc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"rapidHc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"tsysSierra":{"allOf":[{"type":"object","properties":{"bin":{"type":"string","nullable":true},"mid":{"type":"string","nullable":true},"mvv":{"type":"string","nullable":true},"agentBankNumber":{"type":"string","nullable":true},"agentChainNumber":{"type":"string","nullable":true},"storeNumber":{"type":"string","nullable":true},"terminalNumber":{"type":"string","nullable":true},"industryCode":{"enum":["Unknown","A","B","D","F","G","H","L","O","P","R"],"type":"string"},"currencyCode":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"cityCode":{"type":"string","nullable":true},"languageIndicator":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"mcc":{"type":"string","nullable":true},"merchantName":{"type":"string","nullable":true},"merchantLocation":{"type":"string","nullable":true},"merchantState":{"type":"string","nullable":true},"merchantLocationNumber":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"}},"additionalProperties":false}],"nullable":true},"sageAch":{"allOf":[{"type":"object","properties":{"terminals":{"type":"array","items":{"type":"object","properties":{"terminalId":{"type":"string","nullable":true},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"},"type":{"enum":["OneTime","Recurring"],"type":"string"},"dlRequired":{"type":"boolean"},"idRequired":{"type":"boolean"},"checkVerification":{"type":"boolean"},"isGatewayTerminal":{"type":"boolean"},"allowCredits":{"type":"boolean"},"checkLimit":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"hasLevel2Verification":{"type":"boolean"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"features":{"allOf":[{"type":"object","properties":{"hideInVirtualTerminal":{"type":"boolean","nullable":true},"disableAutoSettle":{"type":"boolean","nullable":true},"availableSecCodes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}],"nullable":true},"supportedPaymentMethods":{"type":"array","items":{"type":"string"},"nullable":true},"supportedCurrencies":{"type":"array","items":{"type":"string"},"nullable":true},"isDefaultCard":{"type":"boolean"},"isDefaultAch":{"type":"boolean"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "processorId": {
            "type": "string",
            "format": "uuid"
          },
          "processorType": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "processorTypeId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "enum": [
                      "CreditCard",
                      "Ach"
                    ],
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "merchantId": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "hour": {
            "type": "integer",
            "format": "int32"
          },
          "minute": {
            "type": "integer",
            "format": "int32"
          },
          "paymentAdjustmentTypeId": {
            "enum": [
              "NoAdj",
              "Flat",
              "Percentage"
            ],
            "type": "string"
          },
          "paymentAdjustmentType": {
            "type": "string",
            "nullable": true
          },
          "paymentAdjustmentLabel": {
            "enum": [
              "NoLabel",
              "ConvenienceFee",
              "ServiceFee",
              "AdminFee",
              "ShippingHandlingFee"
            ],
            "type": "string"
          },
          "paymentAdjustmentValue": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "preferences": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "metadataId": {
                  "type": "integer",
                  "format": "int32"
                },
                "preferenceName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataValue": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDisplayName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDescription": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDataType": {
                  "type": "string",
                  "nullable": true
                },
                "isPublic": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "settings": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "rapidOtc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "rapidHc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "tsysSierra": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "bin": {
                            "type": "string",
                            "nullable": true
                          },
                          "mid": {
                            "type": "string",
                            "nullable": true
                          },
                          "mvv": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentBankNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentChainNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "storeNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "industryCode": {
                            "enum": [
                              "Unknown",
                              "A",
                              "B",
                              "D",
                              "F",
                              "G",
                              "H",
                              "L",
                              "O",
                              "P",
                              "R"
                            ],
                            "type": "string"
                          },
                          "currencyCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "countryCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "cityCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "languageIndicator": {
                            "type": "string",
                            "nullable": true
                          },
                          "timeZone": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantName": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocation": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantState": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocationNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "sageAch": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "terminals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "terminalId": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "secCode": {
                                  "enum": [
                                    "PPD",
                                    "CCD",
                                    "WEB",
                                    "TEL"
                                  ],
                                  "type": "string"
                                },
                                "type": {
                                  "enum": [
                                    "OneTime",
                                    "Recurring"
                                  ],
                                  "type": "string"
                                },
                                "dlRequired": {
                                  "type": "boolean"
                                },
                                "idRequired": {
                                  "type": "boolean"
                                },
                                "checkVerification": {
                                  "type": "boolean"
                                },
                                "isGatewayTerminal": {
                                  "type": "boolean"
                                },
                                "allowCredits": {
                                  "type": "boolean"
                                },
                                "checkLimit": {
                                  "type": "integer",
                                  "format": "int32"
                                }
                              },
                              "additionalProperties": false
                            },
                            "nullable": true
                          },
                          "hasLevel2Verification": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "features": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "hideInVirtualTerminal": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "disableAutoSettle": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "availableSecCodes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "supportedPaymentMethods": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "supportedCurrencies": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "isDefaultCard": {
            "type": "boolean"
          },
          "isDefaultAch": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GetProcessorDetailsModelListStatus
204 No Content No Content GetProcessorDetailsModelListStatus
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden GetProcessorDetailsModelListStatus
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Processor

POST /api/Gateway/{gatewayId}/Processor

Body parameter

{
  "allOf": [
    {
      "required": [
        "name",
        "paymentAdjustmentType",
        "paymentAdjustmentValue",
        "processorType",
        "sourceId",
        "timezone"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "processorType": {
          "minLength": 1,
          "type": "string"
        },
        "description": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "timezone": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "settleAt": {
          "type": "string",
          "format": "date-span"
        },
        "paymentAdjustmentType": {
          "enum": [
            "NoAdj",
            "Flat",
            "Percentage"
          ],
          "type": "string"
        },
        "paymentAdjustmentValue": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "sourceId": {
          "minLength": 1,
          "type": "string"
        },
        "isDefaultCard": {
          "type": "boolean"
        },
        "isDefaultAch": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"processorId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertProcessorResponseIResult
207 Multi-Status Success InsertProcessorResponseIResult
400 Bad Request Bad Request InsertProcessorResponseIResult
401 Unauthorized Unauthorized InsertProcessorResponseIResult
403 Forbidden Forbidden InsertProcessorResponseIResult
404 Not Found Not Found InsertProcessorResponseIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}Processor{processorId}

GET /api/Gateway/{gatewayId}/Processor/{processorId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
processorId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"name":{"type":"string","nullable":true},"processorId":{"type":"string","format":"uuid"},"processorType":{"allOf":[{"type":"object","properties":{"processorTypeId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"type":{"enum":["CreditCard","Ach"],"type":"string"}},"additionalProperties":false}],"nullable":true},"merchantId":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"paymentAdjustmentTypeId":{"enum":["NoAdj","Flat","Percentage"],"type":"string"},"paymentAdjustmentType":{"type":"string","nullable":true},"paymentAdjustmentLabel":{"enum":["NoLabel","ConvenienceFee","ServiceFee","AdminFee","ShippingHandlingFee"],"type":"string"},"paymentAdjustmentValue":{"type":"number","format":"double","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"preferences":{"type":"array","items":{"type":"object","properties":{"metadataId":{"type":"integer","format":"int32"},"preferenceName":{"type":"string","nullable":true},"metadataName":{"type":"string","nullable":true},"metadataValue":{"type":"string","nullable":true},"metadataDisplayName":{"type":"string","nullable":true},"metadataDescription":{"type":"string","nullable":true},"metadataDataType":{"type":"string","nullable":true},"isPublic":{"type":"boolean"}},"additionalProperties":false},"nullable":true},"settings":{"allOf":[{"type":"object","properties":{"rapidOtc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"rapidHc":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"},"did":{"type":"string","nullable":true},"visaMcc":{"type":"string","nullable":true},"mcMcc":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"tsysSierra":{"allOf":[{"type":"object","properties":{"bin":{"type":"string","nullable":true},"mid":{"type":"string","nullable":true},"mvv":{"type":"string","nullable":true},"agentBankNumber":{"type":"string","nullable":true},"agentChainNumber":{"type":"string","nullable":true},"storeNumber":{"type":"string","nullable":true},"terminalNumber":{"type":"string","nullable":true},"industryCode":{"enum":["Unknown","A","B","D","F","G","H","L","O","P","R"],"type":"string"},"currencyCode":{"type":"string","nullable":true},"countryCode":{"type":"string","nullable":true},"cityCode":{"type":"string","nullable":true},"languageIndicator":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"mcc":{"type":"string","nullable":true},"merchantName":{"type":"string","nullable":true},"merchantLocation":{"type":"string","nullable":true},"merchantState":{"type":"string","nullable":true},"merchantLocationNumber":{"type":"string","nullable":true},"classification":{"enum":["Ecomm","MOTO","Retail"],"type":"string"}},"additionalProperties":false}],"nullable":true},"sageAch":{"allOf":[{"type":"object","properties":{"terminals":{"type":"array","items":{"type":"object","properties":{"terminalId":{"type":"string","nullable":true},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"},"type":{"enum":["OneTime","Recurring"],"type":"string"},"dlRequired":{"type":"boolean"},"idRequired":{"type":"boolean"},"checkVerification":{"type":"boolean"},"isGatewayTerminal":{"type":"boolean"},"allowCredits":{"type":"boolean"},"checkLimit":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"hasLevel2Verification":{"type":"boolean"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"features":{"allOf":[{"type":"object","properties":{"hideInVirtualTerminal":{"type":"boolean","nullable":true},"disableAutoSettle":{"type":"boolean","nullable":true},"availableSecCodes":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false}],"nullable":true},"supportedPaymentMethods":{"type":"array","items":{"type":"string"},"nullable":true},"supportedCurrencies":{"type":"array","items":{"type":"string"},"nullable":true},"isDefaultCard":{"type":"boolean"},"isDefaultAch":{"type":"boolean"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "nullable": true
            },
            "processorId": {
              "type": "string",
              "format": "uuid"
            },
            "processorType": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "processorTypeId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdDateTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "type": {
                      "enum": [
                        "CreditCard",
                        "Ach"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "timezone": {
              "type": "string",
              "nullable": true
            },
            "hour": {
              "type": "integer",
              "format": "int32"
            },
            "minute": {
              "type": "integer",
              "format": "int32"
            },
            "paymentAdjustmentTypeId": {
              "enum": [
                "NoAdj",
                "Flat",
                "Percentage"
              ],
              "type": "string"
            },
            "paymentAdjustmentType": {
              "type": "string",
              "nullable": true
            },
            "paymentAdjustmentLabel": {
              "enum": [
                "NoLabel",
                "ConvenienceFee",
                "ServiceFee",
                "AdminFee",
                "ShippingHandlingFee"
              ],
              "type": "string"
            },
            "paymentAdjustmentValue": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "preferences": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "metadataId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "preferenceName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataValue": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDisplayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDescription": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDataType": {
                    "type": "string",
                    "nullable": true
                  },
                  "isPublic": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "settings": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "rapidOtc": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "merchantId": {
                              "type": "string",
                              "nullable": true
                            },
                            "groupId": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalId": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            },
                            "did": {
                              "type": "string",
                              "nullable": true
                            },
                            "visaMcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcMcc": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "rapidHc": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "merchantId": {
                              "type": "string",
                              "nullable": true
                            },
                            "groupId": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalId": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            },
                            "did": {
                              "type": "string",
                              "nullable": true
                            },
                            "visaMcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcMcc": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "tsysSierra": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "bin": {
                              "type": "string",
                              "nullable": true
                            },
                            "mid": {
                              "type": "string",
                              "nullable": true
                            },
                            "mvv": {
                              "type": "string",
                              "nullable": true
                            },
                            "agentBankNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "agentChainNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "storeNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "industryCode": {
                              "enum": [
                                "Unknown",
                                "A",
                                "B",
                                "D",
                                "F",
                                "G",
                                "H",
                                "L",
                                "O",
                                "P",
                                "R"
                              ],
                              "type": "string"
                            },
                            "currencyCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "countryCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "cityCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "languageIndicator": {
                              "type": "string",
                              "nullable": true
                            },
                            "timeZone": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantName": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantLocation": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantState": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantLocationNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "sageAch": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "terminals": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "secCode": {
                                    "enum": [
                                      "PPD",
                                      "CCD",
                                      "WEB",
                                      "TEL"
                                    ],
                                    "type": "string"
                                  },
                                  "type": {
                                    "enum": [
                                      "OneTime",
                                      "Recurring"
                                    ],
                                    "type": "string"
                                  },
                                  "dlRequired": {
                                    "type": "boolean"
                                  },
                                  "idRequired": {
                                    "type": "boolean"
                                  },
                                  "checkVerification": {
                                    "type": "boolean"
                                  },
                                  "isGatewayTerminal": {
                                    "type": "boolean"
                                  },
                                  "allowCredits": {
                                    "type": "boolean"
                                  },
                                  "checkLimit": {
                                    "type": "integer",
                                    "format": "int32"
                                  }
                                },
                                "additionalProperties": false
                              },
                              "nullable": true
                            },
                            "hasLevel2Verification": {
                              "type": "boolean"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "features": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "hideInVirtualTerminal": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "disableAutoSettle": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "availableSecCodes": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "supportedPaymentMethods": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "supportedCurrencies": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "isDefaultCard": {
              "type": "boolean"
            },
            "isDefaultAch": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success GetProcessorDetailsModelIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden GetProcessorDetailsModelIResult
404 Not Found Not Found GetProcessorDetailsModelIResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}Processor{processorId}

PUT /api/Gateway/{gatewayId}/Processor/{processorId}

Body parameter

{
  "allOf": [
    {
      "required": [
        "name",
        "paymentAdjustmentType",
        "paymentAdjustmentValue",
        "processorType",
        "timezone"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "processorType": {
          "minLength": 1,
          "type": "string"
        },
        "description": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "timezone": {
          "maxLength": 50,
          "minLength": 1,
          "type": "string"
        },
        "settleAt": {
          "type": "string",
          "format": "date-span"
        },
        "paymentAdjustmentType": {
          "enum": [
            "NoAdj",
            "Flat",
            "Percentage"
          ],
          "type": "string"
        },
        "paymentAdjustmentValue": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "isDefaultCard": {
          "type": "boolean"
        },
        "isDefaultAch": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
processorId path string(uuid) true none
sourceProcessorId query string false none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"processorId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success InsertProcessorResponseIResult
207 Multi-Status Success InsertProcessorResponseIResult
400 Bad Request Bad Request InsertProcessorResponseIResult
401 Unauthorized Unauthorized InsertProcessorResponseIResult
403 Forbidden Forbidden InsertProcessorResponseIResult
404 Not Found Not Found InsertProcessorResponseIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Processor{processorId}

DELETE /api/Gateway/{gatewayId}/Processor/{processorId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
processorId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"processorId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content InsertProcessorResponseIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized InsertProcessorResponseIResult
403 Forbidden Forbidden InsertProcessorResponseIResult
404 Not Found Not Found InsertProcessorResponseIResult
500 Internal Server Error Server Error ObjectIResult

Product

post_api_Gateway{gatewayId}_Product

POST /api/Gateway/{gatewayId}/Product

Body parameter

{
  "allOf": [
    {
      "required": [
        "name",
        "unitPrice"
      ],
      "type": "object",
      "properties": {
        "name": {
          "minLength": 1,
          "type": "string"
        },
        "description": {
          "maxLength": 100,
          "type": "string",
          "nullable": true
        },
        "unitPrice": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "unitOfMeasureId": {
          "type": "integer",
          "format": "int32",
          "nullable": true
        },
        "image": {
          "allOf": [
            {
              "required": [
                "data",
                "fileName"
              ],
              "type": "object",
              "properties": {
                "fileName": {
                  "minLength": 1,
                  "type": "string"
                },
                "data": {
                  "maxLength": 1048576,
                  "type": "string",
                  "format": "byte"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "localTaxPercent": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "nationalTaxPercent": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "productId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created ResponseInsertProductIResult
400 Bad Request Bad Request ResponseInsertProductIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponseInsertProductIResult
409 Conflict Conflict ResponseInsertProductIResult
500 Internal Server Error Server Error ResponseInsertProductIResult

patch_api_Gateway{gatewayId}_Product

PATCH /api/Gateway/{gatewayId}/Product

Body parameter

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "value": {
        "nullable": true
      },
      "path": {
        "type": "string",
        "nullable": true
      },
      "op": {
        "type": "string",
        "nullable": true
      },
      "from": {
        "type": "string",
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body Operation false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true},"data":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponsePatchProductListStatus
207 Multi-Status Success ResponsePatchProductListStatus
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponsePatchProductListStatus
404 Not Found Not Found ResponsePatchProductListStatus
422 Unprocessable Entity Client Error ResponsePatchProductListStatus
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}Product{productId}

DELETE /api/Gateway/{gatewayId}/Product/{productId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
productId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}Product{productId}

GET /api/Gateway/{gatewayId}/Product/{productId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
productId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"unitPrice":{"type":"number","format":"double"},"unitOfMeasure":{"allOf":[{"type":"object","properties":{"unitOfMeasureId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"imageUrl":{"type":"string","nullable":true},"localTaxPercent":{"type":"number","format":"double","nullable":true},"nationalTaxPercent":{"type":"number","format":"double","nullable":true},"createdDateTime":{"type":"string","nullable":true},"createdByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "productId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "unitPrice": {
              "type": "number",
              "format": "double"
            },
            "unitOfMeasure": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "unitOfMeasureId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "imageUrl": {
              "type": "string",
              "nullable": true
            },
            "localTaxPercent": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "nationalTaxPercent": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "nullable": true
            },
            "createdByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "modifiedDateTime": {
              "type": "string",
              "nullable": true
            },
            "modifiedByUserId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadProductIResult
204 No Content No Content ResponseReadProductIResult
400 Bad Request Bad Request ResponseReadProductIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ResponseReadProductIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Product_Search

POST /api/Gateway/{gatewayId}/Product/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "productId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "name": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "description": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "sortColumn": {
          "type": "string",
          "nullable": true
        },
        "sortDirection": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"unitPrice":{"type":"number","format":"double"},"unitOfMeasure":{"allOf":[{"type":"object","properties":{"unitOfMeasureId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"imageUrl":{"type":"string","nullable":true},"localTaxPercent":{"type":"number","format":"double","nullable":true},"nationalTaxPercent":{"type":"number","format":"double","nullable":true},"createdDateTime":{"type":"string","nullable":true},"createdByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "productId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "imageUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseReadProductPagedResultIResult
204 No Content No Content ResponseReadProductPagedResultIResult
400 Bad Request Bad Request ResponseReadProductPagedResultIResult
401 Unauthorized Unauthorized ResponseReadProductIResult
403 Forbidden Forbidden ResponseReadProductPagedResultIResult
500 Internal Server Error Server Error ObjectIResult

SavedSearch

post_api_Gateway{gatewayId}User{gatewayUserId}_SavedSearch

POST /api/Gateway/{gatewayId}/User/{gatewayUserId}/SavedSearch

Body parameter

{
  "allOf": [
    {
      "required": [
        "name",
        "type",
        "value"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "schemaVersion": {
          "type": "string",
          "nullable": true
        },
        "type": {
          "enum": [
            "Transaction",
            "Settlement",
            "Customer"
          ],
          "type": "string"
        },
        "value": {
          "maxLength": 4000,
          "minLength": 1,
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"savedSearchId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created InsertSavedSearchResponseIResult
400 Bad Request Bad Request InsertSavedSearchResponseIResult
401 Unauthorized Unauthorized InsertSavedSearchResponseIResult
403 Forbidden Forbidden InsertSavedSearchResponseIResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}User{gatewayUserId}_SavedSearch

GET /api/Gateway/{gatewayId}/User/{gatewayUserId}/SavedSearch

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
type query string false none
api-version header string false none

Enumerated Values

Parameter Value
type Transaction
type Settlement
type Customer

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"savedSearchId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"gatewayScoped":{"type":"boolean"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "gatewayScoped": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success SavedSearchReadResponseIResult
204 No Content No Content SavedSearchReadResponseIResult
400 Bad Request Bad Request SavedSearchReadResponseIResult
401 Unauthorized Unauthorized SavedSearchReadResponseIResult
403 Forbidden Forbidden SavedSearchReadResponseIResult
500 Internal Server Error Server Error ObjectIResult

delete_api_Gateway{gatewayId}User{gatewayUserId}SavedSearch{savedSearchId}

DELETE /api/Gateway/{gatewayId}/User/{gatewayUserId}/SavedSearch/{savedSearchId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
savedSearchId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","additionalProperties":false}
{
  "type": "object",
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult
403 Forbidden Forbidden IResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

get_api_Gateway{gatewayId}User{gatewayUserId}SavedSearch{savedSearchId}

GET /api/Gateway/{gatewayId}/User/{gatewayUserId}/SavedSearch/{savedSearchId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
gatewayUserId path string(uuid) true none
savedSearchId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"savedSearchId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"schemaVersion":{"type":"string","nullable":true},"type":{"enum":["Transaction","Settlement","Customer"],"type":"string"},"value":{"type":"string","nullable":true},"gatewayScoped":{"type":"boolean"},"gatewayId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "schemaVersion": {
              "type": "string",
              "nullable": true
            },
            "type": {
              "enum": [
                "Transaction",
                "Settlement",
                "Customer"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            },
            "gatewayScoped": {
              "type": "boolean"
            },
            "gatewayId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success SavedSearchDetailsResponseIResult
204 No Content No Content SavedSearchDetailsResponseIResult
400 Bad Request Bad Request SavedSearchDetailsResponseIResult
401 Unauthorized Unauthorized SavedSearchDetailsResponseIResult
403 Forbidden Forbidden SavedSearchDetailsResponseIResult
500 Internal Server Error Server Error ObjectIResult

Settlement

post_api_gateway{gatewayId}_Settlement_Search

POST /api/gateway/{gatewayId}/Settlement/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "settlementId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "batchDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "responseCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "integer",
                  "format": "int32",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "sortColumn": {
          "type": "string",
          "nullable": true
        },
        "sortDirection": {
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"settlements":{"type":"array","items":{"type":"object","properties":{"settlementId":{"type":"string","format":"uuid"},"gatewayId":{"type":"string","format":"uuid"},"processorId":{"type":"string","format":"uuid"},"processorName":{"type":"string","nullable":true},"batchDate":{"type":"string","format":"date-time"},"transactionsCount":{"type":"integer","format":"int32"},"capturedAmount":{"type":"number","format":"double"},"creditAmount":{"type":"number","format":"double"},"surchargeAmount":{"type":"number","format":"double"},"paymentAdjustmentAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"netAmount":{"type":"number","format":"double"},"netDepositeAmount":{"type":"number","format":"double"},"responseCode":{"type":"integer","format":"int32"},"responseMessage":{"type":"string","nullable":true},"sourceLastActionAt":{"type":"string","format":"date-time"}},"additionalProperties":false},"nullable":true},"acceptedSettlementsStats":{"allOf":[{"type":"object","properties":{"transactionsCount":{"type":"integer","format":"int32"},"capturedAmount":{"type":"number","format":"double"},"creditAmount":{"type":"number","format":"double"},"surchargeAmount":{"type":"number","format":"double"},"paymentAdjustmentAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"netAmount":{"type":"number","format":"double"},"netDepositeAmount":{"type":"number","format":"double"}},"additionalProperties":false}],"nullable":true},"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"sortColumn":{"type":"string","nullable":true},"sortDirection":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "settlements": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "settlementId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorName": {
                    "type": "string",
                    "nullable": true
                  },
                  "batchDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "transactionsCount": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "capturedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "creditAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "surchargeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "baseAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "netAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "netDepositeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "responseCode": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "responseMessage": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceLastActionAt": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "acceptedSettlementsStats": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "transactionsCount": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "capturedAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "creditAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "surchargeAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "paymentAdjustmentAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "baseAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "netAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "netDepositeAmount": {
                      "type": "number",
                      "format": "double"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "offset": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            },
            "sortColumn": {
              "type": "string",
              "nullable": true
            },
            "sortDirection": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseSearchSettlementIResult
204 No Content No Content ResponseSearchSettlementIResult
400 Bad Request Bad Request ResponseSearchSettlementIResult
401 Unauthorized Unauthorized ResponseSearchSettlementIResult
403 Forbidden Forbidden ResponseSearchSettlementIResult
500 Internal Server Error Server Error ObjectIResult

Tokenization

get_api_v1_Gateway{gatewayId}_Tokenization_Configuration

GET /api/v1/Gateway/{gatewayId}/Tokenization/Configuration

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"cardTokenizer":{"type":"string","nullable":true},"achTokenizer":{"type":"string","nullable":true},"iframeConfiguration":{"allOf":[{"type":"object","properties":{"iqPro":{"allOf":[{"type":"object","properties":{"publicKey":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"iqProV2":{"allOf":[{"type":"object","properties":{"origin":{"type":"string","nullable":true},"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"proxyConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"tokenizationId":{"type":"string","nullable":true},"profiles":{"type":"array","items":{"type":"object","properties":{"profileName":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"profileKey":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"achConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"achUrl":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"apiConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"mobileConfiguration":{"allOf":[{"type":"object","properties":{"iqProV2":{"allOf":[{"type":"object","properties":{"timestamp":{"type":"string","nullable":true},"tokenizationId":{"type":"string","nullable":true},"tokenScheme":{"type":"string","nullable":true},"authenticationKey":{"type":"string","nullable":true},"pci":{"type":"boolean"},"expires":{"type":"string","format":"date-time"}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cardTokenizer": {
              "type": "string",
              "nullable": true
            },
            "achTokenizer": {
              "type": "string",
              "nullable": true
            },
            "iframeConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqPro": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "publicKey": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "origin": {
                              "type": "string",
                              "nullable": true
                            },
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "proxyConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "profiles": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "profileName": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "url": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "profileKey": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              },
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "achConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "achUrl": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "apiConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "mobileConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ReadTokenizationConfigurationIResult
204 No Content No Content ReadTokenizationConfigurationIResult
400 Bad Request Bad Request ReadTokenizationConfigurationIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden ReadTokenizationConfigurationIResult
500 Internal Server Error Server Error ObjectIResult

Transaction

get_api_Gateway{gatewayId}Transaction{transactionId}

GET /api/Gateway/{gatewayId}/Transaction/{transactionId}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"invoiceId":{"type":"string","format":"uuid","nullable":true},"referencedTransactionId":{"type":"string","format":"uuid","nullable":true},"type":{"enum":["Sale","Authorize","Capture","Credit","Refund","Verification"],"type":"string"},"state":{"enum":["Active","MigrationFailure","Archived"],"type":"string"},"paymentMethod":{"enum":["Card","Ach","Token","Terminal"],"type":"string"},"paymentType":{"enum":["Card","Ach","Token","Terminal"],"type":"string"},"poNumber":{"type":"string","nullable":true},"ipAddress":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"transactionSource":{"enum":["Cp","Webhook","Api","Batch","Invoice","Cart","Recurring"],"type":"string"},"emailReceipt":{"type":"boolean"},"emailAddress":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string"},"response":{"type":"string","nullable":true},"responseCode":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"processor":{"allOf":[{"type":"object","properties":{"processorId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"sourceProperties":{"allOf":[{"type":"object","properties":{"sourceUserName":{"type":"string","nullable":true},"sourceTransactionId":{"type":"string","nullable":true},"sourceSettlementBatchId":{"type":"string","nullable":true},"sourceOrderId":{"type":"string","nullable":true},"sourceLastActionAt":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}],"nullable":true},"transactionRemit":{"allOf":[{"type":"object","properties":{"baseAmount":{"type":"number","format":"double"},"amount":{"type":"number","format":"double"},"amountAuthorized":{"type":"number","format":"double"},"amountCaptured":{"type":"number","format":"double"},"amountSettled":{"type":"number","format":"double"},"amountRefunded":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"paymentAdjustmentType":{"enum":["NoAdj","Flat","Percentage"],"type":"string","nullable":true},"paymentAdjustmentValue":{"type":"number","format":"double"},"tip":{"type":"number","format":"double","nullable":true},"cashBack":{"type":"number","format":"double","nullable":true},"taxExempt":{"type":"boolean"},"shippingAmount":{"type":"number","format":"double"},"surcharge":{"type":"number","format":"double"},"discountAmount":{"type":"number","format":"double"},"serviceFee":{"type":"number","format":"double"},"nationalTaxAmount":{"type":"number","format":"double"},"dutyAmount":{"type":"number","format":"double"},"currencyCode":{"enum":["USD"],"type":"string"}},"additionalProperties":false}],"nullable":true},"transactionAddresses":{"type":"array","items":{"type":"object","properties":{"transactionAddressId":{"type":"string","format":"uuid"},"isPhysical":{"type":"boolean"},"isShipping":{"type":"boolean"},"isBilling":{"type":"boolean"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"transactionPaymentMethod":{"allOf":[{"type":"object","properties":{"transactionPaymentMethodId":{"type":"string","format":"uuid"},"ach":{"allOf":[{"type":"object","properties":{"maskedAccount":{"type":"string","nullable":true},"accountType":{"enum":["Checking","Savings"],"type":"string"},"secCode":{"enum":["PPD","CCD","WEB","TEL"],"type":"string"}},"additionalProperties":false}],"nullable":true},"card":{"allOf":[{"type":"object","properties":{"maskedCard":{"type":"string","nullable":true},"cardType":{"enum":["Visa","MasterCard","Discover","AmericanExpress"],"type":"string"},"expirationDate":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"avsResponse":{"type":"string","nullable":true},"cvvResponse":{"type":"string","nullable":true},"cardHolderName":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"customer":{"allOf":[{"type":"object","properties":{"customerId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"modifiedDateTime":{"type":"string","format":"date-time"},"capturedDateTime":{"type":"string","format":"date-time","nullable":true},"settledDateTime":{"type":"string","format":"date-time","nullable":true},"settlementId":{"type":"string","format":"uuid","nullable":true},"createdByUser":{"allOf":[{"type":"object","properties":{"gatewayUserId":{"type":"string","format":"uuid"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"gateway":{"allOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"transactionFeatures":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","nullable":true},"displayName":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"customFieldEntries":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"value":{"type":"string","nullable":true},"modifiedByUserId":{"type":"string","format":"uuid"},"modifiedDateTime":{"type":"string","format":"date-time"},"type":{"type":"string","nullable":true},"customFieldCategoryName":{"type":"string","nullable":true},"customFieldCategoryId":{"type":"integer","format":"int32"},"dataType":{"type":"string","nullable":true}},"additionalProperties":false},"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "invoiceId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "referencedTransactionId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "type": {
              "enum": [
                "Sale",
                "Authorize",
                "Capture",
                "Credit",
                "Refund",
                "Verification"
              ],
              "type": "string"
            },
            "state": {
              "enum": [
                "Active",
                "MigrationFailure",
                "Archived"
              ],
              "type": "string"
            },
            "paymentMethod": {
              "enum": [
                "Card",
                "Ach",
                "Token",
                "Terminal"
              ],
              "type": "string"
            },
            "paymentType": {
              "enum": [
                "Card",
                "Ach",
                "Token",
                "Terminal"
              ],
              "type": "string"
            },
            "poNumber": {
              "type": "string",
              "nullable": true
            },
            "ipAddress": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "transactionSource": {
              "enum": [
                "Cp",
                "Webhook",
                "Api",
                "Batch",
                "Invoice",
                "Cart",
                "Recurring"
              ],
              "type": "string"
            },
            "emailReceipt": {
              "type": "boolean"
            },
            "emailAddress": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string"
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "string",
              "nullable": true
            },
            "authCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "processor": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "processorId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    },
                    "type": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "sourceProperties": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "sourceUserName": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceTransactionId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceSettlementBatchId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceOrderId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceLastActionAt": {
                      "type": "string",
                      "format": "date-time",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionRemit": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "baseAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountAuthorized": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountCaptured": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountSettled": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountRefunded": {
                      "type": "number",
                      "format": "double"
                    },
                    "taxAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "paymentAdjustmentType": {
                      "enum": [
                        "NoAdj",
                        "Flat",
                        "Percentage"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "paymentAdjustmentValue": {
                      "type": "number",
                      "format": "double"
                    },
                    "tip": {
                      "type": "number",
                      "format": "double",
                      "nullable": true
                    },
                    "cashBack": {
                      "type": "number",
                      "format": "double",
                      "nullable": true
                    },
                    "taxExempt": {
                      "type": "boolean"
                    },
                    "shippingAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "surcharge": {
                      "type": "number",
                      "format": "double"
                    },
                    "discountAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "serviceFee": {
                      "type": "number",
                      "format": "double"
                    },
                    "nationalTaxAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "dutyAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currencyCode": {
                      "enum": [
                        "USD"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isPhysical": {
                    "type": "boolean"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "transactionPaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "transactionPaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "ach": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "maskedAccount": {
                              "type": "string",
                              "nullable": true
                            },
                            "accountType": {
                              "enum": [
                                "Checking",
                                "Savings"
                              ],
                              "type": "string"
                            },
                            "secCode": {
                              "enum": [
                                "PPD",
                                "CCD",
                                "WEB",
                                "TEL"
                              ],
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "card": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "maskedCard": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardType": {
                              "enum": [
                                "Visa",
                                "MasterCard",
                                "Discover",
                                "AmericanExpress"
                              ],
                              "type": "string"
                            },
                            "expirationDate": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "avsResponse": {
                      "type": "string",
                      "nullable": true
                    },
                    "cvvResponse": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardHolderName": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "modifiedDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "capturedDateTime": {
              "type": "string",
              "format": "date-time",
              "nullable": true
            },
            "settledDateTime": {
              "type": "string",
              "format": "date-time",
              "nullable": true
            },
            "settlementId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "createdByUser": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayUserId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "firstName": {
                      "type": "string",
                      "nullable": true
                    },
                    "lastName": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionFeatures": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success TransactionDetailResponseIResult
204 No Content No Content TransactionDetailResponseIResult
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized TransactionDetailResponseIResult
403 Forbidden Forbidden TransactionDetailResponseIResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}Transaction{transactionId}_Void

PUT /api/Gateway/{gatewayId}/Transaction/{transactionId}/Void

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "cardPresentPayload": {
          "allOf": [
            {
              "required": [
                "dataWireId",
                "groupId",
                "merchantId",
                "terminalId",
                "transaction"
              ],
              "type": "object",
              "properties": {
                "transaction": {
                  "allOf": [
                    {
                      "required": [
                        "tenderData",
                        "transactionData",
                        "voidData"
                      ],
                      "type": "object",
                      "properties": {
                        "tenderData": {
                          "allOf": [
                            {
                              "required": [
                                "tenderType",
                                "token"
                              ],
                              "type": "object",
                              "properties": {
                                "tenderType": {
                                  "enum": [
                                    "ProcessAsCredit",
                                    "ProcessAsDebit"
                                  ],
                                  "type": "string"
                                },
                                "cardSecurityData": {
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "cvData": {
                                          "type": "string",
                                          "nullable": true
                                        }
                                      },
                                      "additionalProperties": false
                                    }
                                  ],
                                  "nullable": true
                                },
                                "token": {
                                  "minLength": 1,
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        },
                        "transactionData": {
                          "allOf": [
                            {
                              "required": [
                                "entryMode",
                                "merchantCategoryCode",
                                "timeZone",
                                "transactionId",
                                "transactionIsoDate"
                              ],
                              "type": "object",
                              "properties": {
                                "transactionIsoDate": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "timeZone": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "transactionId": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "entryMode": {
                                  "enum": [
                                    "Swiped",
                                    "Keyed",
                                    "Contact",
                                    "Contactless"
                                  ],
                                  "type": "string"
                                },
                                "merchantCategoryCode": {
                                  "minLength": 1,
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        },
                        "voidData": {
                          "allOf": [
                            {
                              "required": [
                                "originalAuthCode",
                                "originalCardResponse",
                                "originalReferenceIsoDateTime",
                                "originalReferenceNumber",
                                "originalResponseCode",
                                "originalStan"
                              ],
                              "type": "object",
                              "properties": {
                                "originalReferenceNumber": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalReferenceIsoDateTime": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalStan": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalResponseCode": {
                                  "enum": [
                                    "UNKN",
                                    "DECL",
                                    "APPR"
                                  ],
                                  "type": "string"
                                },
                                "originalAuthCode": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalCardResponse": {
                                  "minLength": 1,
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        }
                      },
                      "additionalProperties": false
                    }
                  ]
                },
                "merchantId": {
                  "minLength": 1,
                  "type": "string"
                },
                "dataWireId": {
                  "minLength": 1,
                  "type": "string"
                },
                "terminalId": {
                  "minLength": 1,
                  "type": "string"
                },
                "groupId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string","nullable":true},"response":{"type":"string","nullable":true},"responseCode":{"type":"integer","format":"int32","nullable":true},"appliedToBalanceAmount":{"type":"number","format":"double","nullable":true},"remainingBalance":{"type":"number","format":"double","nullable":true},"transactionTotal":{"type":"number","format":"double","nullable":true},"cardPresentResponse":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"dataWireId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"cardBrand":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"expireDate":{"type":"string","nullable":true},"transaction":{"allOf":[{"type":"object","properties":{"transactionType":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"referenceNumber":{"type":"string","nullable":true},"referenceIsoDateTime":{"type":"string","format":"date-time"},"stan":{"type":"string","nullable":true},"responseCode":{"enum":["UNKN","DECL","APPR"],"type":"string","nullable":true},"responseReason":{"type":"string","nullable":true},"cardResponse":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"completionRequired":{"type":"boolean","nullable":true},"approvedAmount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ProcessTransactionResponseIResult
207 Multi-Status Success ProcessTransactionResponseIResult
400 Bad Request Bad Request ProcessTransactionResponseIResult
401 Unauthorized Unauthorized ProcessTransactionResponseIResult
403 Forbidden Forbidden ProcessTransactionResponseIResult
404 Not Found Not Found ProcessTransactionResponseIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}Transaction{transactionId}_Refund

POST /api/Gateway/{gatewayId}/Transaction/{transactionId}/Refund

Body parameter

{
  "allOf": [
    {
      "required": [
        "amount"
      ],
      "type": "object",
      "properties": {
        "amount": {
          "minimum": 0.01,
          "pattern": "^\\d+(\\.\\d{1,2})?$",
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string","nullable":true},"response":{"type":"string","nullable":true},"responseCode":{"type":"integer","format":"int32","nullable":true},"appliedToBalanceAmount":{"type":"number","format":"double","nullable":true},"remainingBalance":{"type":"number","format":"double","nullable":true},"transactionTotal":{"type":"number","format":"double","nullable":true},"cardPresentResponse":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"dataWireId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"cardBrand":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"expireDate":{"type":"string","nullable":true},"transaction":{"allOf":[{"type":"object","properties":{"transactionType":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"referenceNumber":{"type":"string","nullable":true},"referenceIsoDateTime":{"type":"string","format":"date-time"},"stan":{"type":"string","nullable":true},"responseCode":{"enum":["UNKN","DECL","APPR"],"type":"string","nullable":true},"responseReason":{"type":"string","nullable":true},"cardResponse":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"completionRequired":{"type":"boolean","nullable":true},"approvedAmount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ProcessTransactionResponseIResult
207 Multi-Status Success ProcessTransactionResponseIResult
400 Bad Request Bad Request ProcessTransactionResponseIResult
401 Unauthorized Unauthorized ProcessTransactionResponseIResult
403 Forbidden Forbidden ProcessTransactionResponseIResult
404 Not Found Not Found ProcessTransactionResponseIResult
500 Internal Server Error Server Error ObjectIResult

put_api_Gateway{gatewayId}Transaction{transactionId}_Capture

PUT /api/Gateway/{gatewayId}/Transaction/{transactionId}/Capture

Body parameter

{
  "allOf": [
    {
      "required": [
        "amount"
      ],
      "type": "object",
      "properties": {
        "amount": {
          "minimum": 0.01,
          "type": "number",
          "format": "double"
        },
        "cardPresentPayload": {
          "allOf": [
            {
              "required": [
                "dataWireId",
                "groupId",
                "merchantId",
                "terminalId",
                "transaction"
              ],
              "type": "object",
              "properties": {
                "transaction": {
                  "allOf": [
                    {
                      "required": [
                        "captureData",
                        "tenderData",
                        "transactionData"
                      ],
                      "type": "object",
                      "properties": {
                        "tenderData": {
                          "allOf": [
                            {
                              "required": [
                                "tenderType",
                                "token"
                              ],
                              "type": "object",
                              "properties": {
                                "tenderType": {
                                  "enum": [
                                    "ProcessAsCredit",
                                    "ProcessAsDebit"
                                  ],
                                  "type": "string"
                                },
                                "cardSecurityData": {
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "cvData": {
                                          "type": "string",
                                          "nullable": true
                                        }
                                      },
                                      "additionalProperties": false
                                    }
                                  ],
                                  "nullable": true
                                },
                                "token": {
                                  "minLength": 1,
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        },
                        "transactionData": {
                          "allOf": [
                            {
                              "required": [
                                "entryMode",
                                "timeZone",
                                "transactionId",
                                "transactionIsoDate"
                              ],
                              "type": "object",
                              "properties": {
                                "transactionIsoDate": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "timeZone": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "transactionId": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "entryMode": {
                                  "enum": [
                                    "Swiped",
                                    "Keyed",
                                    "Contact",
                                    "Contactless"
                                  ],
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        },
                        "captureData": {
                          "allOf": [
                            {
                              "required": [
                                "originalAuthCode",
                                "originalCardResponse",
                                "originalReferenceIsoDateTime",
                                "originalReferenceNumber",
                                "originalResponseCode",
                                "originalStan"
                              ],
                              "type": "object",
                              "properties": {
                                "originalReferenceNumber": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalReferenceIsoDateTime": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalStan": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalResponseCode": {
                                  "enum": [
                                    "UNKN",
                                    "DECL",
                                    "APPR"
                                  ],
                                  "type": "string"
                                },
                                "originalAuthCode": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "originalCardResponse": {
                                  "minLength": 1,
                                  "type": "string"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        }
                      },
                      "additionalProperties": false
                    }
                  ]
                },
                "merchantId": {
                  "minLength": 1,
                  "type": "string"
                },
                "dataWireId": {
                  "minLength": 1,
                  "type": "string"
                },
                "terminalId": {
                  "minLength": 1,
                  "type": "string"
                },
                "groupId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string","nullable":true},"response":{"type":"string","nullable":true},"responseCode":{"type":"integer","format":"int32","nullable":true},"appliedToBalanceAmount":{"type":"number","format":"double","nullable":true},"remainingBalance":{"type":"number","format":"double","nullable":true},"transactionTotal":{"type":"number","format":"double","nullable":true},"cardPresentResponse":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"dataWireId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"cardBrand":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"expireDate":{"type":"string","nullable":true},"transaction":{"allOf":[{"type":"object","properties":{"transactionType":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"referenceNumber":{"type":"string","nullable":true},"referenceIsoDateTime":{"type":"string","format":"date-time"},"stan":{"type":"string","nullable":true},"responseCode":{"enum":["UNKN","DECL","APPR"],"type":"string","nullable":true},"responseReason":{"type":"string","nullable":true},"cardResponse":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"completionRequired":{"type":"boolean","nullable":true},"approvedAmount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ProcessTransactionResponseIResult
201 Created Created ProcessTransactionResponseIResult
400 Bad Request Bad Request ProcessTransactionResponseIResult
401 Unauthorized Unauthorized ProcessTransactionResponseIResult
403 Forbidden Forbidden ProcessTransactionResponseIResult
404 Not Found Not Found ProcessTransactionResponseIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}Transaction{transactionId}_Receipt_Email

POST /api/Gateway/{gatewayId}/Transaction/{transactionId}/Receipt/Email

Body parameter

{
  "allOf": [
    {
      "required": [
        "from",
        "recipient"
      ],
      "type": "object",
      "properties": {
        "sourceTransactionId": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "recipient": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "to": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "nullable": true
                },
                "name": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "from": {
          "minLength": 1,
          "type": "string",
          "format": "email"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"boolean"}
{
  "type": "boolean"
}

Responses

Status Meaning Description Schema
200 OK Success boolean
400 Bad Request Bad Request boolean
401 Unauthorized Unauthorized boolean
404 Not Found Not Found boolean
500 Internal Server Error Server Error boolean

get_api_Gateway{gatewayId}Transaction{transactionId}_Receipt

GET /api/Gateway/{gatewayId}/Transaction/{transactionId}/Receipt

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
fileType query string false none
api-version header string false none

Enumerated Values

Parameter Value
fileType PDF

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"type":"string","format":"byte","nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ByteArrayIResult
400 Bad Request Bad Request ByteArrayIResult
401 Unauthorized Unauthorized ByteArrayIResult
403 Forbidden Forbidden ByteArrayIResult
404 Not Found Not Found ByteArrayIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Transaction

POST /api/Gateway/{gatewayId}/Transaction

Body parameter

{
  "allOf": [
    {
      "required": [
        "emailReceipt",
        "processorId",
        "transactionPaymentMethod",
        "transactionRemit",
        "transactionSource",
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "Sale",
            "Authorize",
            "Capture",
            "Credit",
            "Refund",
            "Verification"
          ],
          "type": "string"
        },
        "orderId": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "poNumber": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "nullable": true
        },
        "transactionSource": {
          "enum": [
            "Cp",
            "Webhook",
            "Api",
            "Batch",
            "Invoice",
            "Cart",
            "Recurring"
          ],
          "type": "string"
        },
        "vaultCustomer": {
          "type": "boolean"
        },
        "customerName": {
          "type": "string",
          "nullable": true
        },
        "emailReceipt": {
          "type": "boolean"
        },
        "emailAddress": {
          "maxLength": 100,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string",
          "nullable": true
        },
        "transactionPaymentMethod": {
          "allOf": [
            {
              "type": "object",
              "properties": {
                "card": {
                  "allOf": [
                    {
                      "required": [
                        "cardToken",
                        "maskedNumber"
                      ],
                      "type": "object",
                      "properties": {
                        "cardToken": {
                          "maxLength": 50,
                          "minLength": 1,
                          "type": "string"
                        },
                        "cardType": {
                          "enum": [
                            "Visa",
                            "MasterCard",
                            "Discover",
                            "AmericanExpress"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "expirationDate": {
                          "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                          "type": "string",
                          "nullable": true
                        },
                        "maskedNumber": {
                          "minLength": 1,
                          "pattern": "^\\d{6}\\*{6,}\\d{4}$",
                          "type": "string"
                        },
                        "entryType": {
                          "enum": [
                            "Swiped",
                            "Keyed",
                            "Contact",
                            "Contactless"
                          ],
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "ach": {
                  "allOf": [
                    {
                      "required": [
                        "achToken"
                      ],
                      "type": "object",
                      "properties": {
                        "achToken": {
                          "maxLength": 50,
                          "minLength": 1,
                          "type": "string"
                        },
                        "secCode": {
                          "enum": [
                            "PPD",
                            "CCD",
                            "WEB",
                            "TEL"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "routingNumber": {
                          "type": "string",
                          "nullable": true
                        },
                        "accountType": {
                          "enum": [
                            "Checking",
                            "Savings"
                          ],
                          "type": "string",
                          "nullable": true
                        },
                        "checkNumber": {
                          "type": "string",
                          "nullable": true
                        },
                        "accountHolderAuth": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "dlState": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "dlNumber": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "customer": {
                  "allOf": [
                    {
                      "required": [
                        "customerId"
                      ],
                      "type": "object",
                      "properties": {
                        "customerId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "customerPaymentMethodId": {
                          "type": "string",
                          "format": "uuid",
                          "nullable": true
                        },
                        "customerBillingAddressId": {
                          "type": "string",
                          "format": "uuid",
                          "nullable": true
                        },
                        "customerShippingAddressId": {
                          "type": "string",
                          "format": "uuid",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "processorId": {
          "type": "string",
          "format": "uuid"
        },
        "transactionRemit": {
          "allOf": [
            {
              "required": [
                "baseAmount",
                "currencyCode",
                "taxAmount"
              ],
              "type": "object",
              "properties": {
                "baseAmount": {
                  "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                  "type": "number",
                  "format": "double"
                },
                "taxAmount": {
                  "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                  "type": "number",
                  "format": "double"
                },
                "isTaxExempt": {
                  "type": "boolean"
                },
                "currencyCode": {
                  "enum": [
                    "USD"
                  ],
                  "type": "string"
                },
                "addTaxToTotal": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            }
          ]
        },
        "transactionAddress": {
          "maxItems": 2,
          "type": "array",
          "items": {
            "required": [
              "isBilling",
              "isPhysical",
              "isShipping"
            ],
            "type": "object",
            "properties": {
              "isPhysical": {
                "type": "boolean"
              },
              "isShipping": {
                "type": "boolean"
              },
              "isBilling": {
                "type": "boolean"
              },
              "firstName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "lastName": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "company": {
                "maxLength": 50,
                "type": "string",
                "nullable": true
              },
              "email": {
                "maxLength": 100,
                "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
                "type": "string",
                "nullable": true
              },
              "phone": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "fax": {
                "maxLength": 10,
                "pattern": "^(\\d{10})$",
                "type": "string",
                "nullable": true
              },
              "addressLine1": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "addressLine2": {
                "maxLength": 100,
                "type": "string",
                "nullable": true
              },
              "city": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              },
              "state": {
                "maxLength": 3,
                "type": "string",
                "nullable": true
              },
              "postalCode": {
                "maxLength": 10,
                "type": "string",
                "nullable": true
              },
              "country": {
                "maxLength": 40,
                "type": "string",
                "nullable": true
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "transactionPaymentAdjustment": {
          "allOf": [
            {
              "required": [
                "paymentAdjustmentType",
                "paymentAdjustmentValue"
              ],
              "type": "object",
              "properties": {
                "paymentAdjustmentType": {
                  "enum": [
                    "NoAdj",
                    "Flat",
                    "Percentage"
                  ],
                  "type": "string"
                },
                "paymentAdjustmentValue": {
                  "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
                  "type": "number",
                  "format": "double"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customFields": {
          "type": "array",
          "items": {
            "required": [
              "customFieldId",
              "customFieldValue"
            ],
            "type": "object",
            "properties": {
              "customFieldId": {
                "type": "integer",
                "format": "int32"
              },
              "customFieldValue": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        },
        "invoiceId": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "cardPresentPayload": {
          "allOf": [
            {
              "required": [
                "dataWireId",
                "groupId",
                "merchantId",
                "terminalId",
                "transaction"
              ],
              "type": "object",
              "properties": {
                "transaction": {
                  "allOf": [
                    {
                      "required": [
                        "tenderData",
                        "transactionData"
                      ],
                      "type": "object",
                      "properties": {
                        "tenderData": {
                          "allOf": [
                            {
                              "required": [
                                "tenderType"
                              ],
                              "type": "object",
                              "properties": {
                                "tenderType": {
                                  "enum": [
                                    "ProcessAsCredit",
                                    "ProcessAsDebit"
                                  ],
                                  "type": "string"
                                },
                                "cardSecurityData": {
                                  "allOf": [
                                    {
                                      "type": "object",
                                      "properties": {
                                        "cvData": {
                                          "type": "string",
                                          "nullable": true
                                        }
                                      },
                                      "additionalProperties": false
                                    }
                                  ],
                                  "nullable": true
                                },
                                "trackTwoSecondHalf": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "emvTlv": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        },
                        "transactionData": {
                          "allOf": [
                            {
                              "required": [
                                "timeZone",
                                "transactionId",
                                "transactionIsoDate"
                              ],
                              "type": "object",
                              "properties": {
                                "transactionIsoDate": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "timeZone": {
                                  "minLength": 1,
                                  "type": "string"
                                },
                                "transactionId": {
                                  "type": "string",
                                  "format": "uuid"
                                }
                              },
                              "additionalProperties": false
                            }
                          ]
                        }
                      },
                      "additionalProperties": false
                    }
                  ]
                },
                "merchantId": {
                  "minLength": 1,
                  "type": "string"
                },
                "dataWireId": {
                  "minLength": 1,
                  "type": "string"
                },
                "terminalId": {
                  "minLength": 1,
                  "type": "string"
                },
                "groupId": {
                  "minLength": 1,
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"processorResponseCode":{"type":"string","nullable":true},"processorResponseText":{"type":"string","nullable":true},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string","nullable":true},"response":{"type":"string","nullable":true},"responseCode":{"type":"integer","format":"int32","nullable":true},"appliedToBalanceAmount":{"type":"number","format":"double","nullable":true},"remainingBalance":{"type":"number","format":"double","nullable":true},"transactionTotal":{"type":"number","format":"double","nullable":true},"cardPresentResponse":{"allOf":[{"type":"object","properties":{"merchantId":{"type":"string","nullable":true},"dataWireId":{"type":"string","nullable":true},"terminalId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true},"timeZone":{"type":"string","nullable":true},"cardBrand":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"expireDate":{"type":"string","nullable":true},"transaction":{"allOf":[{"type":"object","properties":{"transactionType":{"type":"string","nullable":true},"transactionId":{"type":"string","nullable":true},"referenceNumber":{"type":"string","nullable":true},"referenceIsoDateTime":{"type":"string","format":"date-time"},"stan":{"type":"string","nullable":true},"responseCode":{"enum":["UNKN","DECL","APPR"],"type":"string","nullable":true},"responseReason":{"type":"string","nullable":true},"cardResponse":{"type":"string","nullable":true},"authCode":{"type":"string","nullable":true},"completionRequired":{"type":"boolean","nullable":true},"approvedAmount":{"type":"number","format":"double","nullable":true},"currency":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created ProcessTransactionResponseIResult
207 Multi-Status Success ProcessTransactionResponseIResult
400 Bad Request Bad Request ProcessTransactionResponseIResult
401 Unauthorized Unauthorized ProcessTransactionResponseIResult
403 Forbidden Forbidden ProcessTransactionResponseIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}Transaction{transactionId}_Customer

POST /api/Gateway/{gatewayId}/Transaction/{transactionId}/Customer

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "customerName": {
          "maxLength": 50,
          "type": "string",
          "nullable": true
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
transactionId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"customerId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created ResponseInsertTransactionCustomerIResult
400 Bad Request Bad Request ResponseInsertTransactionCustomerIResult
401 Unauthorized Unauthorized ResponseInsertTransactionCustomerIResult
403 Forbidden Forbidden ResponseInsertTransactionCustomerIResult
404 Not Found Not Found ResponseInsertTransactionCustomerIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Transaction_Search

POST /api/Gateway/{gatewayId}/Transaction/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "amount": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountAuthorized": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountCaptured": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountSettled": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "taxAmount": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "capturedDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "settledDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "modifiedDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "creditCardFirst6": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "creditCardLast4": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "achRoutingNumber": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "ipAddress": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "poNumber": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "referenceTransactionId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "settlementBatchId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "status": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Unknown",
                    "Declined",
                    "Authorized",
                    "PendingSettlement",
                    "Settled",
                    "Voided",
                    "Refunded",
                    "Returned",
                    "LateReturn",
                    "Pending",
                    "PartiallyRefunded"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "transactionId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "source": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Cp",
                    "Webhook",
                    "Api",
                    "Batch",
                    "Invoice",
                    "Cart",
                    "Recurring"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "type": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Sale",
                    "Authorize",
                    "Capture",
                    "Credit",
                    "Refund",
                    "Verification"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "userName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "userId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "invoiceId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFirstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingLastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCity": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCountry": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingState": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPostalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPhone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingFirstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingLastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCity": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCountry": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingState": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingPostalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingPhone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingFax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "sortColumn": {
          "pattern": "^(CreatedDateTime|Status|CustomerName|MaskedAccount|MaskedCard|Amount)$",
          "type": "string",
          "nullable": true
        },
        "sortDirection": {
          "pattern": "^(DESC|ASC)$",
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid"},"type":{"enum":["Sale","Authorize","Capture","Credit","Refund","Verification"],"type":"string"},"paymentMethod":{"enum":["Card","Ach","Token","Terminal"],"type":"string"},"status":{"enum":["Unknown","Declined","Authorized","PendingSettlement","Settled","Voided","Refunded","Returned","LateReturn","Pending","PartiallyRefunded"],"type":"string"},"amount":{"type":"number","format":"double"},"amountAuthorized":{"type":"number","format":"double"},"amountCaptured":{"type":"number","format":"double"},"amountRefunded":{"type":"number","format":"double"},"maskedCard":{"type":"string","nullable":true},"maskedAccount":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"customerName":{"type":"string","nullable":true},"billingFirstName":{"type":"string","nullable":true},"billingLastName":{"type":"string","nullable":true},"invoiceId":{"type":"string","format":"uuid","nullable":true},"createdDateTime":{"type":"string","format":"date-time"}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentMethod": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "amount": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountAuthorized": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountCaptured": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountRefunded": {
                    "type": "number",
                    "format": "double"
                  },
                  "maskedCard": {
                    "type": "string",
                    "nullable": true
                  },
                  "maskedAccount": {
                    "type": "string",
                    "nullable": true
                  },
                  "customerId": {
                    "type": "string",
                    "format": "uuid",
                    "nullable": true
                  },
                  "customerName": {
                    "type": "string",
                    "nullable": true
                  },
                  "billingFirstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "billingLastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "invoiceId": {
                    "type": "string",
                    "format": "uuid",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success ResponseSearchTransactionPagedResultIResult
204 No Content No Content ResponseSearchTransactionPagedResultIResult
400 Bad Request Bad Request ResponseSearchTransactionPagedResultIResult
401 Unauthorized Unauthorized ResponseSearchTransactionPagedResultIResult
403 Forbidden Forbidden ResponseSearchTransactionPagedResultIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Transaction_SearchCsv

POST /api/Gateway/{gatewayId}/Transaction/SearchCsv

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "amount": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountAuthorized": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountCaptured": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "amountSettled": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "taxAmount": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsGreaterOrEqual",
                    "IsLesserOrEqual",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "number",
                  "format": "double",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "capturedDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "settledDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "modifiedDateTime": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "creditCardFirst6": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "creditCardLast4": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "achRoutingNumber": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "customerName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "ipAddress": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "poNumber": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "processorName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "referenceTransactionId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "settlementBatchId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "status": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Unknown",
                    "Declined",
                    "Authorized",
                    "PendingSettlement",
                    "Settled",
                    "Voided",
                    "Refunded",
                    "Returned",
                    "LateReturn",
                    "Pending",
                    "PartiallyRefunded"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "transactionId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "source": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Cp",
                    "Webhook",
                    "Api",
                    "Batch",
                    "Invoice",
                    "Cart",
                    "Recurring"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "type": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "Sale",
                    "Authorize",
                    "Capture",
                    "Credit",
                    "Refund",
                    "Verification"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "userName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "userId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "invoiceId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingAddressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFirstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingLastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCity": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingCountry": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingState": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPostalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingPhone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "billingFax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressLine1": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingAddressLine2": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingFirstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingLastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCompany": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCity": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingCountry": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingState": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingPostalCode": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingEmail": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingPhone": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "shippingFax": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "offset": {
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "type": "integer",
          "format": "int32"
        },
        "sortColumn": {
          "pattern": "^(CreatedDateTime|Status|CustomerName|MaskedAccount|MaskedCard|Amount)$",
          "type": "string",
          "nullable": true
        },
        "sortDirection": {
          "pattern": "^(DESC|ASC)$",
          "type": "string",
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

400 Response

Responses

Status Meaning Description Schema
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

post_api_Gateway{gatewayId}_Transaction_CalculateFees

POST /api/Gateway/{gatewayId}/Transaction/CalculateFees

Body parameter

{
  "allOf": [
    {
      "required": [
        "addTaxToTotal",
        "baseAmount",
        "creditCardBin",
        "processorId"
      ],
      "type": "object",
      "properties": {
        "creditCardBin": {
          "maxLength": 6,
          "minLength": 0,
          "pattern": "^[0-9]*$",
          "type": "string"
        },
        "state": {
          "maxLength": 3,
          "type": "string",
          "nullable": true
        },
        "baseAmount": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "paymentAdjustmentType": {
          "enum": [
            "NoAdj",
            "Flat",
            "Percentage"
          ],
          "type": "string",
          "nullable": true
        },
        "paymentAdjustmentValue": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double",
          "nullable": true
        },
        "addTaxToTotal": {
          "type": "boolean"
        },
        "taxAmount": {
          "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
          "type": "number",
          "format": "double"
        },
        "processorId": {
          "type": "string",
          "format": "uuid"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
gatewayId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"isSurchargeable":{"type":"boolean"},"surchargeAmount":{"type":"number","format":"double"},"serviceFeesAmount":{"type":"number","format":"double"},"convenienceFeesAmount":{"type":"number","format":"double"},"baseAmount":{"type":"number","format":"double"},"amount":{"type":"number","format":"double"},"taxAmount":{"type":"number","format":"double"},"cardBrand":{"type":"string","nullable":true},"cardType":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "isSurchargeable": {
              "type": "boolean"
            },
            "surchargeAmount": {
              "type": "number",
              "format": "double"
            },
            "serviceFeesAmount": {
              "type": "number",
              "format": "double"
            },
            "convenienceFeesAmount": {
              "type": "number",
              "format": "double"
            },
            "baseAmount": {
              "type": "number",
              "format": "double"
            },
            "amount": {
              "type": "number",
              "format": "double"
            },
            "taxAmount": {
              "type": "number",
              "format": "double"
            },
            "cardBrand": {
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success TransactionFeesResponseModelIResult
400 Bad Request Bad Request TransactionFeesResponseModelIResult
401 Unauthorized Unauthorized TransactionFeesResponseModelIResult
403 Forbidden Forbidden TransactionFeesResponseModelIResult
500 Internal Server Error Server Error ObjectIResult

User

post__api_User

POST /api/User

Body parameter

{
  "allOf": [
    {
      "required": [
        "email",
        "firstName",
        "lastName",
        "roleId"
      ],
      "type": "object",
      "properties": {
        "email": {
          "maxLength": 100,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
          "type": "string"
        },
        "firstName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "lastName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "roleId": {
          "type": "string",
          "format": "uuid"
        },
        "permissionIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
api-version header string false none
body body any false none

Example responses

201 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"userId":{"type":"string","format":"uuid"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
201 Created Created UserDetailsBaseModelIResult
400 Bad Request Bad Request Inline
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

Response Schema

post__api_User_Search

POST /api/User/Search

Body parameter

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "userId": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "email": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "firstName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "lastName": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "IsLike",
                    "IsNotLike",
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "status": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Equal",
                    "NotEqual"
                  ],
                  "type": "string"
                },
                "value": {
                  "enum": [
                    "InvitePending",
                    "PendingTOS",
                    "Active",
                    "Disabled"
                  ],
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "createdDate": {
          "allOf": [
            {
              "required": [
                "operator"
              ],
              "type": "object",
              "properties": {
                "operator": {
                  "enum": [
                    "Between"
                  ],
                  "type": "string"
                },
                "startDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                },
                "endDate": {
                  "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            }
          ],
          "nullable": true
        },
        "includeUserPermissions": {
          "type": "boolean"
        },
        "includeUserRole": {
          "type": "boolean"
        },
        "offSet": {
          "maximum": 2147483647,
          "minimum": 0,
          "type": "integer",
          "format": "int32"
        },
        "limit": {
          "maximum": 100,
          "minimum": 1,
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"email":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"userPermissions":{"type":"array","items":{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"userRole":{"enum":["SU","SA","GA","GS"],"type":"string","nullable":true}},"additionalProperties":false},"nullable":true},"offSet":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "status": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "userPermissions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "permissionId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "code": {
                          "type": "string",
                          "nullable": true
                        },
                        "description": {
                          "type": "string",
                          "nullable": true
                        },
                        "order": {
                          "type": "integer",
                          "format": "int32"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "userRole": {
                    "enum": [
                      "SU",
                      "SA",
                      "GA",
                      "GS"
                    ],
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UserDetailResponsePagedResultIResult
204 No Content No Content None
400 Bad Request Bad Request UserDetailResponsePagedResultIResult
401 Unauthorized Unauthorized UserDetailResponsePagedResultIResult
403 Forbidden Forbidden UserDetailResponsePagedResultIResult
500 Internal Server Error Server Error ObjectIResult

put_api_User{userId}

PUT /api/User/{userId}

Body parameter

{
  "allOf": [
    {
      "required": [
        "firstName",
        "lastName",
        "roleId",
        "status"
      ],
      "type": "object",
      "properties": {
        "firstName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "lastName": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "status": {
          "enum": [
            "InvitePending",
            "PendingTOS",
            "Active",
            "Disabled"
          ],
          "type": "string"
        },
        "roleId": {
          "type": "string",
          "format": "uuid"
        },
        "permissionIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  ]
}

Parameters

Name In Type Required Description
userId path string(uuid) true none
api-version header string false none
body body any false none

Example responses

200 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"email":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"createdDateTime":{"type":"string","format":"date-time"},"userPermissions":{"type":"array","items":{"type":"object","properties":{"permissionId":{"type":"string","format":"uuid"},"code":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"order":{"type":"integer","format":"int32"}},"additionalProperties":false},"nullable":true},"userRole":{"enum":["SU","SA","GA","GS"],"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "type": "string",
              "nullable": true
            },
            "lastName": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "userPermissions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "permissionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "order": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "userRole": {
              "enum": [
                "SU",
                "SA",
                "GA",
                "GS"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
200 OK Success UserDetailResponseIResult
400 Bad Request Bad Request UserDetailResponseIResult
401 Unauthorized Unauthorized ObjectIResult
403 Forbidden Forbidden UserDetailResponseIResult
404 Not Found Not Found IResult
500 Internal Server Error Server Error ObjectIResult

delete_api_User{userId}

DELETE /api/User/{userId}

Parameters

Name In Type Required Description
UserId path string(uuid) true none
api-version header string false none

Example responses

204 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult`1
400 Bad Request Bad Request ObjectIResult
401 Unauthorized Unauthorized IResult`1
403 Forbidden Forbidden IResult`1
404 Not Found Not Found IResult`1
500 Internal Server Error Server Error ObjectIResult

post__api_User_AcceptTos

POST /api/User/AcceptTos

Parameters

Name In Type Required Description
api-version header string false none

Example responses

204 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
204 No Content No Content IResult`1
400 Bad Request Bad Request Inline
401 Unauthorized Unauthorized ObjectIResult
500 Internal Server Error Server Error ObjectIResult

Response Schema

post_api_User{userId}_Invite

POST /api/User/{userId}/Invite

Parameters

Name In Type Required Description
userId path string(uuid) true none
api-version header string false none

Example responses

400 Response

{"type":"object","properties":{"statusCode":{"enum":["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","Ambiguous","Moved","Redirect","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string","readOnly":true},"statusDetails":{"type":"array","items":{"type":"string"},"nullable":true,"readOnly":true},"data":{"allOf":[{"type":"object","additionalProperties":false}],"nullable":true,"readOnly":true},"byteData":{"type":"string","format":"byte","nullable":true,"readOnly":true},"contentType":{"type":"string","nullable":true,"readOnly":true}},"additionalProperties":false}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Responses

Status Meaning Description Schema
400 Bad Request Bad Request IResult`1
401 Unauthorized Unauthorized IResult`1
403 Forbidden Forbidden IResult`1
404 Not Found Not Found IResult`1
500 Internal Server Error Server Error ObjectIResult

Schemas

AchAccountHolderAuth

{
  "type": "object",
  "properties": {
    "dlState": {
      "type": "string",
      "nullable": true
    },
    "dlNumber": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
dlState string¦null false none none
dlNumber string¦null false none none

AchResponse

{
  "type": "object",
  "properties": {
    "achId": {
      "type": "string",
      "format": "uuid"
    },
    "maskedAccount": {
      "type": "string",
      "nullable": true
    },
    "accountType": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string"
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string"
    },
    "token": {
      "type": "string",
      "nullable": true
    },
    "sourceReferenceId": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
achId string(uuid) false none none
maskedAccount string¦null false none none
accountType string false none none
secCode string false none none
token string¦null false none none
sourceReferenceId string¦null false none none

Enumerated Values

Property Value
accountType Checking
accountType Savings
secCode PPD
secCode CCD
secCode WEB
secCode TEL

AddressCreateModel

{
  "type": "object",
  "properties": {
    "addressLine1": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "city": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "maxLength": 16,
      "type": "string",
      "nullable": true
    },
    "country": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "firstName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "email": {
      "maxLength": 100,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "fax": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "company": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isPhysical": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none
firstName string¦null false none none
lastName string¦null false none none
email string(email)¦null false none none
phone string¦null false none none
fax string¦null false none none
company string¦null false none none
isShipping boolean false none none
isBilling boolean false none none
isPhysical boolean false none none

AddressDetailsBaseModel

{
  "type": "object",
  "properties": {
    "customerAddressId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerAddressId string(uuid) false none none

AddressDetailsBaseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerAddressId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data AddressDetailsBaseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

AddressDetailsModel

{
  "type": "object",
  "properties": {
    "isPhysical": {
      "type": "boolean"
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "firstName": {
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "type": "string",
      "nullable": true
    },
    "company": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "fax": {
      "type": "string",
      "nullable": true
    },
    "addressLine1": {
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "type": "string",
      "nullable": true
    },
    "city": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "sourceReferenceId": {
      "type": "string",
      "nullable": true
    },
    "customerAddressId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isPhysical boolean false none none
isShipping boolean false none none
isBilling boolean false none none
firstName string¦null false none none
lastName string¦null false none none
company string¦null false none none
email string¦null false none none
phone string¦null false none none
fax string¦null false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none
sourceReferenceId string¦null false none none
customerAddressId string(uuid) false none none

AddressDetailsModel2

{
  "type": "object",
  "properties": {
    "gatewayAddressId": {
      "type": "string",
      "format": "uuid"
    },
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "addressId": {
      "type": "string",
      "format": "uuid"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isInvoice": {
      "type": "boolean"
    },
    "addressModel": {
      "allOf": [
        {
          "required": [
            "addressLine1",
            "firstName"
          ],
          "type": "object",
          "properties": {
            "addressLine1": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "addressLine2": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "city": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "state": {
              "maxLength": 3,
              "type": "string",
              "nullable": true
            },
            "postalCode": {
              "maxLength": 16,
              "type": "string",
              "nullable": true
            },
            "country": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "lastName": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "email": {
              "maxLength": 100,
              "type": "string",
              "format": "email",
              "nullable": true
            },
            "phone": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "fax": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "company": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayAddressId string(uuid) false none none
gatewayId string(uuid) false none none
addressId string(uuid) false none none
isPrimary boolean false none none
isBilling boolean false none none
isInvoice boolean false none none
addressModel AddressModel¦null false none none

AddressInsertModel

{
  "type": "object",
  "properties": {
    "isPrimary": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isInvoice": {
      "type": "boolean"
    },
    "address": {
      "allOf": [
        {
          "required": [
            "addressLine1",
            "firstName"
          ],
          "type": "object",
          "properties": {
            "addressLine1": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "addressLine2": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "city": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "state": {
              "maxLength": 3,
              "type": "string",
              "nullable": true
            },
            "postalCode": {
              "maxLength": 16,
              "type": "string",
              "nullable": true
            },
            "country": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "lastName": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "email": {
              "maxLength": 100,
              "type": "string",
              "format": "email",
              "nullable": true
            },
            "phone": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "fax": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "company": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isPrimary boolean false none none
isBilling boolean false none none
isInvoice boolean false none none
address AddressModel¦null false none none

AddressModel

{
  "required": [
    "addressLine1",
    "firstName"
  ],
  "type": "object",
  "properties": {
    "addressLine1": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "addressLine2": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "city": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "maxLength": 16,
      "type": "string",
      "nullable": true
    },
    "country": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "firstName": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "email": {
      "maxLength": 100,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "fax": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "company": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
addressLine1 string true none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none
firstName string true none none
lastName string¦null false none none
email string(email)¦null false none none
phone string¦null false none none
fax string¦null false none none
company string¦null false none none

ByteArrayIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data string(byte)¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CPCaptureCardSecurityData

{
  "type": "object",
  "properties": {
    "cvData": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cvData string¦null false none none

CPCaptureData

{
  "required": [
    "originalAuthCode",
    "originalCardResponse",
    "originalReferenceIsoDateTime",
    "originalReferenceNumber",
    "originalResponseCode",
    "originalStan"
  ],
  "type": "object",
  "properties": {
    "originalReferenceNumber": {
      "minLength": 1,
      "type": "string"
    },
    "originalReferenceIsoDateTime": {
      "minLength": 1,
      "type": "string"
    },
    "originalStan": {
      "minLength": 1,
      "type": "string"
    },
    "originalResponseCode": {
      "enum": [
        "UNKN",
        "DECL",
        "APPR"
      ],
      "type": "string"
    },
    "originalAuthCode": {
      "minLength": 1,
      "type": "string"
    },
    "originalCardResponse": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
originalReferenceNumber string true none none
originalReferenceIsoDateTime string true none none
originalStan string true none none
originalResponseCode string true none none
originalAuthCode string true none none
originalCardResponse string true none none

Enumerated Values

Property Value
originalResponseCode UNKN
originalResponseCode DECL
originalResponseCode APPR

CPCapturePayload

{
  "required": [
    "dataWireId",
    "groupId",
    "merchantId",
    "terminalId",
    "transaction"
  ],
  "type": "object",
  "properties": {
    "transaction": {
      "allOf": [
        {
          "required": [
            "captureData",
            "tenderData",
            "transactionData"
          ],
          "type": "object",
          "properties": {
            "tenderData": {
              "allOf": [
                {
                  "required": [
                    "tenderType",
                    "token"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderType": {
                      "enum": [
                        "ProcessAsCredit",
                        "ProcessAsDebit"
                      ],
                      "type": "string"
                    },
                    "cardSecurityData": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "cvData": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "token": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "transactionData": {
              "allOf": [
                {
                  "required": [
                    "entryMode",
                    "timeZone",
                    "transactionId",
                    "transactionIsoDate"
                  ],
                  "type": "object",
                  "properties": {
                    "transactionIsoDate": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "timeZone": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "transactionId": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "entryMode": {
                      "enum": [
                        "Swiped",
                        "Keyed",
                        "Contact",
                        "Contactless"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "captureData": {
              "allOf": [
                {
                  "required": [
                    "originalAuthCode",
                    "originalCardResponse",
                    "originalReferenceIsoDateTime",
                    "originalReferenceNumber",
                    "originalResponseCode",
                    "originalStan"
                  ],
                  "type": "object",
                  "properties": {
                    "originalReferenceNumber": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalReferenceIsoDateTime": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalStan": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalResponseCode": {
                      "enum": [
                        "UNKN",
                        "DECL",
                        "APPR"
                      ],
                      "type": "string"
                    },
                    "originalAuthCode": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalCardResponse": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "merchantId": {
      "minLength": 1,
      "type": "string"
    },
    "dataWireId": {
      "minLength": 1,
      "type": "string"
    },
    "terminalId": {
      "minLength": 1,
      "type": "string"
    },
    "groupId": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transaction CPCaptureTransaction true none none
merchantId string true none none
dataWireId string true none none
terminalId string true none none
groupId string true none none

CPCaptureTenderData

{
  "required": [
    "tenderType",
    "token"
  ],
  "type": "object",
  "properties": {
    "tenderType": {
      "enum": [
        "ProcessAsCredit",
        "ProcessAsDebit"
      ],
      "type": "string"
    },
    "cardSecurityData": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cvData": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "token": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderType string true none none
cardSecurityData CPCaptureCardSecurityData¦null false none none
token string true none none

Enumerated Values

Property Value
tenderType ProcessAsCredit
tenderType ProcessAsDebit

CPCaptureTransaction

{
  "required": [
    "captureData",
    "tenderData",
    "transactionData"
  ],
  "type": "object",
  "properties": {
    "tenderData": {
      "allOf": [
        {
          "required": [
            "tenderType",
            "token"
          ],
          "type": "object",
          "properties": {
            "tenderType": {
              "enum": [
                "ProcessAsCredit",
                "ProcessAsDebit"
              ],
              "type": "string"
            },
            "cardSecurityData": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "cvData": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "token": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionData": {
      "allOf": [
        {
          "required": [
            "entryMode",
            "timeZone",
            "transactionId",
            "transactionIsoDate"
          ],
          "type": "object",
          "properties": {
            "transactionIsoDate": {
              "minLength": 1,
              "type": "string"
            },
            "timeZone": {
              "minLength": 1,
              "type": "string"
            },
            "transactionId": {
              "minLength": 1,
              "type": "string"
            },
            "entryMode": {
              "enum": [
                "Swiped",
                "Keyed",
                "Contact",
                "Contactless"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "captureData": {
      "allOf": [
        {
          "required": [
            "originalAuthCode",
            "originalCardResponse",
            "originalReferenceIsoDateTime",
            "originalReferenceNumber",
            "originalResponseCode",
            "originalStan"
          ],
          "type": "object",
          "properties": {
            "originalReferenceNumber": {
              "minLength": 1,
              "type": "string"
            },
            "originalReferenceIsoDateTime": {
              "minLength": 1,
              "type": "string"
            },
            "originalStan": {
              "minLength": 1,
              "type": "string"
            },
            "originalResponseCode": {
              "enum": [
                "UNKN",
                "DECL",
                "APPR"
              ],
              "type": "string"
            },
            "originalAuthCode": {
              "minLength": 1,
              "type": "string"
            },
            "originalCardResponse": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderData CPCaptureTenderData true none none
transactionData CPCaptureTransactionData true none none
captureData CPCaptureData true none none

CPCaptureTransactionData

{
  "required": [
    "entryMode",
    "timeZone",
    "transactionId",
    "transactionIsoDate"
  ],
  "type": "object",
  "properties": {
    "transactionIsoDate": {
      "minLength": 1,
      "type": "string"
    },
    "timeZone": {
      "minLength": 1,
      "type": "string"
    },
    "transactionId": {
      "minLength": 1,
      "type": "string"
    },
    "entryMode": {
      "enum": [
        "Swiped",
        "Keyed",
        "Contact",
        "Contactless"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionIsoDate string true none none
timeZone string true none none
transactionId string true none none
entryMode string true none none

Enumerated Values

Property Value
entryMode Swiped
entryMode Keyed
entryMode Contact
entryMode Contactless

CPCardSecurityData

{
  "type": "object",
  "properties": {
    "cvData": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cvData string¦null false none none

CPTenderData

{
  "required": [
    "tenderType"
  ],
  "type": "object",
  "properties": {
    "tenderType": {
      "enum": [
        "ProcessAsCredit",
        "ProcessAsDebit"
      ],
      "type": "string"
    },
    "cardSecurityData": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cvData": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "trackTwoSecondHalf": {
      "type": "string",
      "nullable": true
    },
    "emvTlv": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderType string true none none
cardSecurityData CPCardSecurityData¦null false none none
trackTwoSecondHalf string¦null false none none
emvTlv string¦null false none none

Enumerated Values

Property Value
tenderType ProcessAsCredit
tenderType ProcessAsDebit

CPTransaction

{
  "required": [
    "tenderData",
    "transactionData"
  ],
  "type": "object",
  "properties": {
    "tenderData": {
      "allOf": [
        {
          "required": [
            "tenderType"
          ],
          "type": "object",
          "properties": {
            "tenderType": {
              "enum": [
                "ProcessAsCredit",
                "ProcessAsDebit"
              ],
              "type": "string"
            },
            "cardSecurityData": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "cvData": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "trackTwoSecondHalf": {
              "type": "string",
              "nullable": true
            },
            "emvTlv": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionData": {
      "allOf": [
        {
          "required": [
            "timeZone",
            "transactionId",
            "transactionIsoDate"
          ],
          "type": "object",
          "properties": {
            "transactionIsoDate": {
              "minLength": 1,
              "type": "string"
            },
            "timeZone": {
              "minLength": 1,
              "type": "string"
            },
            "transactionId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderData CPTenderData true none none
transactionData CPTransactionData true none none

CPTransactionData

{
  "required": [
    "timeZone",
    "transactionId",
    "transactionIsoDate"
  ],
  "type": "object",
  "properties": {
    "transactionIsoDate": {
      "minLength": 1,
      "type": "string"
    },
    "timeZone": {
      "minLength": 1,
      "type": "string"
    },
    "transactionId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionIsoDate string true none none
timeZone string true none none
transactionId string(uuid) true none none

CPTransactionResponse

{
  "type": "object",
  "properties": {
    "transactionType": {
      "type": "string",
      "nullable": true
    },
    "transactionId": {
      "type": "string",
      "nullable": true
    },
    "referenceNumber": {
      "type": "string",
      "nullable": true
    },
    "referenceIsoDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "stan": {
      "type": "string",
      "nullable": true
    },
    "responseCode": {
      "enum": [
        "UNKN",
        "DECL",
        "APPR"
      ],
      "type": "string",
      "nullable": true
    },
    "responseReason": {
      "type": "string",
      "nullable": true
    },
    "cardResponse": {
      "type": "string",
      "nullable": true
    },
    "authCode": {
      "type": "string",
      "nullable": true
    },
    "completionRequired": {
      "type": "boolean",
      "nullable": true
    },
    "approvedAmount": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "currency": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionType string¦null false none none
transactionId string¦null false none none
referenceNumber string¦null false none none
referenceIsoDateTime string(date-time) false none none
stan string¦null false none none
responseCode string¦null false none none
responseReason string¦null false none none
cardResponse string¦null false none none
authCode string¦null false none none
completionRequired boolean¦null false none none
approvedAmount number(double)¦null false none none
currency string¦null false none none

Enumerated Values

Property Value
responseCode UNKN
responseCode DECL
responseCode APPR

CPVoidCardSecurityData

{
  "type": "object",
  "properties": {
    "cvData": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cvData string¦null false none none

CPVoidData

{
  "required": [
    "originalAuthCode",
    "originalCardResponse",
    "originalReferenceIsoDateTime",
    "originalReferenceNumber",
    "originalResponseCode",
    "originalStan"
  ],
  "type": "object",
  "properties": {
    "originalReferenceNumber": {
      "minLength": 1,
      "type": "string"
    },
    "originalReferenceIsoDateTime": {
      "minLength": 1,
      "type": "string"
    },
    "originalStan": {
      "minLength": 1,
      "type": "string"
    },
    "originalResponseCode": {
      "enum": [
        "UNKN",
        "DECL",
        "APPR"
      ],
      "type": "string"
    },
    "originalAuthCode": {
      "minLength": 1,
      "type": "string"
    },
    "originalCardResponse": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
originalReferenceNumber string true none none
originalReferenceIsoDateTime string true none none
originalStan string true none none
originalResponseCode string true none none
originalAuthCode string true none none
originalCardResponse string true none none

Enumerated Values

Property Value
originalResponseCode UNKN
originalResponseCode DECL
originalResponseCode APPR

CPVoidPayload

{
  "required": [
    "dataWireId",
    "groupId",
    "merchantId",
    "terminalId",
    "transaction"
  ],
  "type": "object",
  "properties": {
    "transaction": {
      "allOf": [
        {
          "required": [
            "tenderData",
            "transactionData",
            "voidData"
          ],
          "type": "object",
          "properties": {
            "tenderData": {
              "allOf": [
                {
                  "required": [
                    "tenderType",
                    "token"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderType": {
                      "enum": [
                        "ProcessAsCredit",
                        "ProcessAsDebit"
                      ],
                      "type": "string"
                    },
                    "cardSecurityData": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "cvData": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "token": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "transactionData": {
              "allOf": [
                {
                  "required": [
                    "entryMode",
                    "merchantCategoryCode",
                    "timeZone",
                    "transactionId",
                    "transactionIsoDate"
                  ],
                  "type": "object",
                  "properties": {
                    "transactionIsoDate": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "timeZone": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "transactionId": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "entryMode": {
                      "enum": [
                        "Swiped",
                        "Keyed",
                        "Contact",
                        "Contactless"
                      ],
                      "type": "string"
                    },
                    "merchantCategoryCode": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "voidData": {
              "allOf": [
                {
                  "required": [
                    "originalAuthCode",
                    "originalCardResponse",
                    "originalReferenceIsoDateTime",
                    "originalReferenceNumber",
                    "originalResponseCode",
                    "originalStan"
                  ],
                  "type": "object",
                  "properties": {
                    "originalReferenceNumber": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalReferenceIsoDateTime": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalStan": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalResponseCode": {
                      "enum": [
                        "UNKN",
                        "DECL",
                        "APPR"
                      ],
                      "type": "string"
                    },
                    "originalAuthCode": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "originalCardResponse": {
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "merchantId": {
      "minLength": 1,
      "type": "string"
    },
    "dataWireId": {
      "minLength": 1,
      "type": "string"
    },
    "terminalId": {
      "minLength": 1,
      "type": "string"
    },
    "groupId": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transaction CPVoidTransaction true none none
merchantId string true none none
dataWireId string true none none
terminalId string true none none
groupId string true none none

CPVoidTenderData

{
  "required": [
    "tenderType",
    "token"
  ],
  "type": "object",
  "properties": {
    "tenderType": {
      "enum": [
        "ProcessAsCredit",
        "ProcessAsDebit"
      ],
      "type": "string"
    },
    "cardSecurityData": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cvData": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "token": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderType string true none none
cardSecurityData CPVoidCardSecurityData¦null false none none
token string true none none

Enumerated Values

Property Value
tenderType ProcessAsCredit
tenderType ProcessAsDebit

CPVoidTransaction

{
  "required": [
    "tenderData",
    "transactionData",
    "voidData"
  ],
  "type": "object",
  "properties": {
    "tenderData": {
      "allOf": [
        {
          "required": [
            "tenderType",
            "token"
          ],
          "type": "object",
          "properties": {
            "tenderType": {
              "enum": [
                "ProcessAsCredit",
                "ProcessAsDebit"
              ],
              "type": "string"
            },
            "cardSecurityData": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "cvData": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "token": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionData": {
      "allOf": [
        {
          "required": [
            "entryMode",
            "merchantCategoryCode",
            "timeZone",
            "transactionId",
            "transactionIsoDate"
          ],
          "type": "object",
          "properties": {
            "transactionIsoDate": {
              "minLength": 1,
              "type": "string"
            },
            "timeZone": {
              "minLength": 1,
              "type": "string"
            },
            "transactionId": {
              "minLength": 1,
              "type": "string"
            },
            "entryMode": {
              "enum": [
                "Swiped",
                "Keyed",
                "Contact",
                "Contactless"
              ],
              "type": "string"
            },
            "merchantCategoryCode": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "voidData": {
      "allOf": [
        {
          "required": [
            "originalAuthCode",
            "originalCardResponse",
            "originalReferenceIsoDateTime",
            "originalReferenceNumber",
            "originalResponseCode",
            "originalStan"
          ],
          "type": "object",
          "properties": {
            "originalReferenceNumber": {
              "minLength": 1,
              "type": "string"
            },
            "originalReferenceIsoDateTime": {
              "minLength": 1,
              "type": "string"
            },
            "originalStan": {
              "minLength": 1,
              "type": "string"
            },
            "originalResponseCode": {
              "enum": [
                "UNKN",
                "DECL",
                "APPR"
              ],
              "type": "string"
            },
            "originalAuthCode": {
              "minLength": 1,
              "type": "string"
            },
            "originalCardResponse": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tenderData CPVoidTenderData true none none
transactionData CPVoidTransactionData true none none
voidData CPVoidData true none none

CPVoidTransactionData

{
  "required": [
    "entryMode",
    "merchantCategoryCode",
    "timeZone",
    "transactionId",
    "transactionIsoDate"
  ],
  "type": "object",
  "properties": {
    "transactionIsoDate": {
      "minLength": 1,
      "type": "string"
    },
    "timeZone": {
      "minLength": 1,
      "type": "string"
    },
    "transactionId": {
      "minLength": 1,
      "type": "string"
    },
    "entryMode": {
      "enum": [
        "Swiped",
        "Keyed",
        "Contact",
        "Contactless"
      ],
      "type": "string"
    },
    "merchantCategoryCode": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionIsoDate string true none none
timeZone string true none none
transactionId string true none none
entryMode string true none none
merchantCategoryCode string true none none

Enumerated Values

Property Value
entryMode Swiped
entryMode Keyed
entryMode Contact
entryMode Contactless

CardPresentPayload

{
  "required": [
    "dataWireId",
    "groupId",
    "merchantId",
    "terminalId",
    "transaction"
  ],
  "type": "object",
  "properties": {
    "transaction": {
      "allOf": [
        {
          "required": [
            "tenderData",
            "transactionData"
          ],
          "type": "object",
          "properties": {
            "tenderData": {
              "allOf": [
                {
                  "required": [
                    "tenderType"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderType": {
                      "enum": [
                        "ProcessAsCredit",
                        "ProcessAsDebit"
                      ],
                      "type": "string"
                    },
                    "cardSecurityData": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "cvData": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "trackTwoSecondHalf": {
                      "type": "string",
                      "nullable": true
                    },
                    "emvTlv": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "transactionData": {
              "allOf": [
                {
                  "required": [
                    "timeZone",
                    "transactionId",
                    "transactionIsoDate"
                  ],
                  "type": "object",
                  "properties": {
                    "transactionIsoDate": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "timeZone": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "transactionId": {
                      "type": "string",
                      "format": "uuid"
                    }
                  },
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "merchantId": {
      "minLength": 1,
      "type": "string"
    },
    "dataWireId": {
      "minLength": 1,
      "type": "string"
    },
    "terminalId": {
      "minLength": 1,
      "type": "string"
    },
    "groupId": {
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transaction CPTransaction true none none
merchantId string true none none
dataWireId string true none none
terminalId string true none none
groupId string true none none

CardPresentResponse

{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string",
      "nullable": true
    },
    "dataWireId": {
      "type": "string",
      "nullable": true
    },
    "terminalId": {
      "type": "string",
      "nullable": true
    },
    "groupId": {
      "type": "string",
      "nullable": true
    },
    "timeZone": {
      "type": "string",
      "nullable": true
    },
    "cardBrand": {
      "type": "string",
      "nullable": true
    },
    "token": {
      "type": "string",
      "nullable": true
    },
    "expireDate": {
      "type": "string",
      "nullable": true
    },
    "transaction": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionType": {
              "type": "string",
              "nullable": true
            },
            "transactionId": {
              "type": "string",
              "nullable": true
            },
            "referenceNumber": {
              "type": "string",
              "nullable": true
            },
            "referenceIsoDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "stan": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "enum": [
                "UNKN",
                "DECL",
                "APPR"
              ],
              "type": "string",
              "nullable": true
            },
            "responseReason": {
              "type": "string",
              "nullable": true
            },
            "cardResponse": {
              "type": "string",
              "nullable": true
            },
            "authCode": {
              "type": "string",
              "nullable": true
            },
            "completionRequired": {
              "type": "boolean",
              "nullable": true
            },
            "approvedAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "currency": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
merchantId string¦null false none none
dataWireId string¦null false none none
terminalId string¦null false none none
groupId string¦null false none none
timeZone string¦null false none none
cardBrand string¦null false none none
token string¦null false none none
expireDate string¦null false none none
transaction CPTransactionResponse¦null false none none

CardResponse

{
  "type": "object",
  "properties": {
    "cardId": {
      "type": "string",
      "format": "uuid"
    },
    "maskedCard": {
      "type": "string",
      "nullable": true
    },
    "token": {
      "type": "string",
      "nullable": true
    },
    "cardType": {
      "enum": [
        "Visa",
        "MasterCard",
        "Discover",
        "AmericanExpress"
      ],
      "type": "string"
    },
    "expirationDate": {
      "type": "string",
      "nullable": true
    },
    "sourceReferenceId": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cardId string(uuid) false none none
maskedCard string¦null false none none
token string¦null false none none
cardType string false none none
expirationDate string¦null false none none
sourceReferenceId string¦null false none none

Enumerated Values

Property Value
cardType Visa
cardType MasterCard
cardType Discover
cardType AmericanExpress

CustomFieldEntryModel

{
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "value": {
      "type": "string",
      "nullable": true
    },
    "modifiedByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "modifiedDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "customFieldCategoryName": {
      "type": "string",
      "nullable": true
    },
    "customFieldCategoryId": {
      "type": "integer",
      "format": "int32"
    },
    "dataType": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldId integer(int32) false none none
name string¦null false none none
value string¦null false none none
modifiedByUserId string(uuid) false none none
modifiedDateTime string(date-time) false none none
type string¦null false none none
customFieldCategoryName string¦null false none none
customFieldCategoryId integer(int32) false none none
dataType string¦null false none none

CustomFieldModel

{
  "required": [
    "customFieldId",
    "customFieldValue"
  ],
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "integer",
      "format": "int32"
    },
    "customFieldValue": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldId integer(int32) true none none
customFieldValue [string] true none none

CustomFieldOptionResponse

{
  "type": "object",
  "properties": {
    "customFieldOptionId": {
      "type": "integer",
      "format": "int32"
    },
    "value": {
      "type": "string",
      "nullable": true
    },
    "label": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldOptionId integer(int32) false none none
value string¦null false none none
label string¦null false none none

CustomFieldResponse

{
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "type": "string",
      "nullable": true
    },
    "dataType": {
      "type": "string",
      "nullable": true
    },
    "orderNumber": {
      "type": "integer",
      "format": "int32"
    },
    "isRequired": {
      "type": "boolean"
    },
    "customFieldOption": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldOptionId": {
            "type": "integer",
            "format": "int32"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "label": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldId integer(int32) false none none
name string¦null false none none
type string¦null false none none
dataType string¦null false none none
orderNumber integer(int32) false none none
isRequired boolean false none none
customFieldOption [CustomFieldOptionResponse]¦null false none none

CustomFieldResponseListIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "customFieldOption": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldOptionId": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "label": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [CustomFieldResponse]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomFieldsTypeResponse

{
  "type": "object",
  "properties": {
    "customFieldCategoryId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "customer": {
      "type": "boolean"
    },
    "transaction": {
      "type": "boolean"
    },
    "invoice": {
      "type": "boolean"
    },
    "customFields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "customFieldOption": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldOptionId": {
                  "type": "integer",
                  "format": "int32"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "label": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldCategoryId integer(int32) false none none
name string¦null false none none
description string¦null false none none
customer boolean false none none
transaction boolean false none none
invoice boolean false none none
customFields [CustomFieldResponse]¦null false none none

CustomFieldsTypeResponseListIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "customer": {
            "type": "boolean"
          },
          "transaction": {
            "type": "boolean"
          },
          "invoice": {
            "type": "boolean"
          },
          "customFields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldId": {
                  "type": "integer",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "type": {
                  "type": "string",
                  "nullable": true
                },
                "dataType": {
                  "type": "string",
                  "nullable": true
                },
                "orderNumber": {
                  "type": "integer",
                  "format": "int32"
                },
                "isRequired": {
                  "type": "boolean"
                },
                "customFieldOption": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "customFieldOptionId": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      },
                      "label": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [CustomFieldsTypeResponse]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerCreateModel

{
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "maxLength": 255,
      "type": "string",
      "nullable": true
    },
    "addresses": {
      "maxItems": 25,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "addressLine1": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "city": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          },
          "state": {
            "maxLength": 3,
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "maxLength": 16,
            "type": "string",
            "nullable": true
          },
          "country": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          },
          "firstName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "email": {
            "maxLength": 100,
            "type": "string",
            "format": "email",
            "nullable": true
          },
          "phone": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "fax": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "company": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isPhysical": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "customFields": {
      "type": "array",
      "items": {
        "required": [
          "customFieldId",
          "customFieldValue"
        ],
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "customFieldValue": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "payment": {
      "allOf": [
        {
          "required": [
            "isDefault"
          ],
          "type": "object",
          "properties": {
            "card": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedCard": {
                      "maxLength": 19,
                      "minLength": 0,
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "maxLength": 50,
                      "minLength": 0,
                      "type": "string",
                      "nullable": true
                    },
                    "cardType": {
                      "enum": [
                        "Visa",
                        "MasterCard",
                        "Discover",
                        "AmericanExpress",
                        "Diners",
                        "Jcb"
                      ],
                      "type": "string"
                    },
                    "expirationDate": {
                      "maxLength": 5,
                      "minLength": 0,
                      "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "ach": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedAccount": {
                      "maxLength": 50,
                      "minLength": 0,
                      "type": "string",
                      "nullable": true
                    },
                    "accountType": {
                      "enum": [
                        "Checking",
                        "Savings"
                      ],
                      "type": "string"
                    },
                    "secCode": {
                      "enum": [
                        "PPD",
                        "CCD",
                        "WEB",
                        "TEL"
                      ],
                      "type": "string"
                    },
                    "token": {
                      "maxLength": 50,
                      "minLength": 0,
                      "type": "string",
                      "nullable": true
                    },
                    "routingNumber": {
                      "maxLength": 9,
                      "pattern": "\\d{0,9}",
                      "type": "string",
                      "nullable": true
                    },
                    "checkNum": {
                      "type": "integer",
                      "format": "int32",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "isDefault": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string¦null false none none
addresses [AddressCreateModel]¦null false none none
customFields [CustomFieldModel]¦null false none none
payment InsertCustomerPayment¦null false none none

CustomerDetailsBaseModel

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid) false none none

CustomerDetailsBaseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data CustomerDetailsBaseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerDetailsModel

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "sourceReferenceId": {
      "type": "string",
      "nullable": true
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "isPhysical": {
            "type": "boolean"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "fax": {
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          },
          "sourceReferenceId": {
            "type": "string",
            "nullable": true
          },
          "customerAddressId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "paymentMethods": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ach": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "achId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "maskedAccount": {
                    "type": "string",
                    "nullable": true
                  },
                  "accountType": {
                    "enum": [
                      "Checking",
                      "Savings"
                    ],
                    "type": "string"
                  },
                  "secCode": {
                    "enum": [
                      "PPD",
                      "CCD",
                      "WEB",
                      "TEL"
                    ],
                    "type": "string"
                  },
                  "token": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "card": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "cardId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "maskedCard": {
                    "type": "string",
                    "nullable": true
                  },
                  "token": {
                    "type": "string",
                    "nullable": true
                  },
                  "cardType": {
                    "enum": [
                      "Visa",
                      "MasterCard",
                      "Discover",
                      "AmericanExpress"
                    ],
                    "type": "string"
                  },
                  "expirationDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "isDefault": {
            "type": "boolean"
          },
          "paymentMethodId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "customFieldEntries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "modifiedByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "modifiedDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryName": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          },
          "dataType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "statistics": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "addressesCount": {
              "type": "integer",
              "format": "int32"
            },
            "paymentMethodsCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string¦null false none none
description string¦null false none none
createdDateTime string(date-time) false none none
modifiedDateTime string(date-time) false none none
sourceReferenceId string¦null false none none
addresses [AddressDetailsModel]¦null false none none
paymentMethods [PaymentMethodModel]¦null false none none
customFieldEntries [CustomFieldEntryModel]¦null false none none
statistics CustomerStat¦null false none none
customerId string(uuid) false none none

CustomerDetailsModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "modifiedDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            },
            "addresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "isPhysical": {
                    "type": "boolean"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  },
                  "customerAddressId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "paymentMethods": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ach": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "achId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "maskedAccount": {
                            "type": "string",
                            "nullable": true
                          },
                          "accountType": {
                            "enum": [
                              "Checking",
                              "Savings"
                            ],
                            "type": "string"
                          },
                          "secCode": {
                            "enum": [
                              "PPD",
                              "CCD",
                              "WEB",
                              "TEL"
                            ],
                            "type": "string"
                          },
                          "token": {
                            "type": "string",
                            "nullable": true
                          },
                          "sourceReferenceId": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "card": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "cardId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "maskedCard": {
                            "type": "string",
                            "nullable": true
                          },
                          "token": {
                            "type": "string",
                            "nullable": true
                          },
                          "cardType": {
                            "enum": [
                              "Visa",
                              "MasterCard",
                              "Discover",
                              "AmericanExpress"
                            ],
                            "type": "string"
                          },
                          "expirationDate": {
                            "type": "string",
                            "nullable": true
                          },
                          "sourceReferenceId": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isDefault": {
                    "type": "boolean"
                  },
                  "paymentMethodId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "statistics": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "addressesCount": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "paymentMethodsCount": {
                      "type": "integer",
                      "format": "int32"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data CustomerDetailsModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerDetailsModelPagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "modifiedDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "sourceReferenceId": {
            "type": "string",
            "nullable": true
          },
          "addresses": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "isPhysical": {
                  "type": "boolean"
                },
                "isShipping": {
                  "type": "boolean"
                },
                "isBilling": {
                  "type": "boolean"
                },
                "firstName": {
                  "type": "string",
                  "nullable": true
                },
                "lastName": {
                  "type": "string",
                  "nullable": true
                },
                "company": {
                  "type": "string",
                  "nullable": true
                },
                "email": {
                  "type": "string",
                  "nullable": true
                },
                "phone": {
                  "type": "string",
                  "nullable": true
                },
                "fax": {
                  "type": "string",
                  "nullable": true
                },
                "addressLine1": {
                  "type": "string",
                  "nullable": true
                },
                "addressLine2": {
                  "type": "string",
                  "nullable": true
                },
                "city": {
                  "type": "string",
                  "nullable": true
                },
                "state": {
                  "type": "string",
                  "nullable": true
                },
                "postalCode": {
                  "type": "string",
                  "nullable": true
                },
                "country": {
                  "type": "string",
                  "nullable": true
                },
                "sourceReferenceId": {
                  "type": "string",
                  "nullable": true
                },
                "customerAddressId": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "paymentMethods": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "ach": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "achId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "maskedAccount": {
                          "type": "string",
                          "nullable": true
                        },
                        "accountType": {
                          "enum": [
                            "Checking",
                            "Savings"
                          ],
                          "type": "string"
                        },
                        "secCode": {
                          "enum": [
                            "PPD",
                            "CCD",
                            "WEB",
                            "TEL"
                          ],
                          "type": "string"
                        },
                        "token": {
                          "type": "string",
                          "nullable": true
                        },
                        "sourceReferenceId": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "card": {
                  "allOf": [
                    {
                      "type": "object",
                      "properties": {
                        "cardId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "maskedCard": {
                          "type": "string",
                          "nullable": true
                        },
                        "token": {
                          "type": "string",
                          "nullable": true
                        },
                        "cardType": {
                          "enum": [
                            "Visa",
                            "MasterCard",
                            "Discover",
                            "AmericanExpress"
                          ],
                          "type": "string"
                        },
                        "expirationDate": {
                          "type": "string",
                          "nullable": true
                        },
                        "sourceReferenceId": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    }
                  ],
                  "nullable": true
                },
                "isDefault": {
                  "type": "boolean"
                },
                "paymentMethodId": {
                  "type": "string",
                  "format": "uuid"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "customFieldEntries": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "customFieldId": {
                  "type": "integer",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "modifiedByUserId": {
                  "type": "string",
                  "format": "uuid"
                },
                "modifiedDateTime": {
                  "type": "string",
                  "format": "date-time"
                },
                "type": {
                  "type": "string",
                  "nullable": true
                },
                "customFieldCategoryName": {
                  "type": "string",
                  "nullable": true
                },
                "customFieldCategoryId": {
                  "type": "integer",
                  "format": "int32"
                },
                "dataType": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "statistics": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "addressesCount": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "paymentMethodsCount": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "customerId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [CustomerDetailsModel]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

CustomerDetailsModelPagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "sourceReferenceId": {
                    "type": "string",
                    "nullable": true
                  },
                  "addresses": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "isPhysical": {
                          "type": "boolean"
                        },
                        "isShipping": {
                          "type": "boolean"
                        },
                        "isBilling": {
                          "type": "boolean"
                        },
                        "firstName": {
                          "type": "string",
                          "nullable": true
                        },
                        "lastName": {
                          "type": "string",
                          "nullable": true
                        },
                        "company": {
                          "type": "string",
                          "nullable": true
                        },
                        "email": {
                          "type": "string",
                          "nullable": true
                        },
                        "phone": {
                          "type": "string",
                          "nullable": true
                        },
                        "fax": {
                          "type": "string",
                          "nullable": true
                        },
                        "addressLine1": {
                          "type": "string",
                          "nullable": true
                        },
                        "addressLine2": {
                          "type": "string",
                          "nullable": true
                        },
                        "city": {
                          "type": "string",
                          "nullable": true
                        },
                        "state": {
                          "type": "string",
                          "nullable": true
                        },
                        "postalCode": {
                          "type": "string",
                          "nullable": true
                        },
                        "country": {
                          "type": "string",
                          "nullable": true
                        },
                        "sourceReferenceId": {
                          "type": "string",
                          "nullable": true
                        },
                        "customerAddressId": {
                          "type": "string",
                          "format": "uuid"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "paymentMethods": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ach": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "achId": {
                                  "type": "string",
                                  "format": "uuid"
                                },
                                "maskedAccount": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "accountType": {
                                  "enum": [
                                    "Checking",
                                    "Savings"
                                  ],
                                  "type": "string"
                                },
                                "secCode": {
                                  "enum": [
                                    "PPD",
                                    "CCD",
                                    "WEB",
                                    "TEL"
                                  ],
                                  "type": "string"
                                },
                                "token": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "sourceReferenceId": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        },
                        "card": {
                          "allOf": [
                            {
                              "type": "object",
                              "properties": {
                                "cardId": {
                                  "type": "string",
                                  "format": "uuid"
                                },
                                "maskedCard": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "token": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "cardType": {
                                  "enum": [
                                    "Visa",
                                    "MasterCard",
                                    "Discover",
                                    "AmericanExpress"
                                  ],
                                  "type": "string"
                                },
                                "expirationDate": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "sourceReferenceId": {
                                  "type": "string",
                                  "nullable": true
                                }
                              },
                              "additionalProperties": false
                            }
                          ],
                          "nullable": true
                        },
                        "isDefault": {
                          "type": "boolean"
                        },
                        "paymentMethodId": {
                          "type": "string",
                          "format": "uuid"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "customFieldEntries": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "customFieldId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "name": {
                          "type": "string",
                          "nullable": true
                        },
                        "value": {
                          "type": "string",
                          "nullable": true
                        },
                        "modifiedByUserId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "modifiedDateTime": {
                          "type": "string",
                          "format": "date-time"
                        },
                        "type": {
                          "type": "string",
                          "nullable": true
                        },
                        "customFieldCategoryName": {
                          "type": "string",
                          "nullable": true
                        },
                        "customFieldCategoryId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "dataType": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "statistics": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "addressesCount": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "paymentMethodsCount": {
                            "type": "integer",
                            "format": "int32"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "customerId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data CustomerDetailsModelPagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerPaymentMethodResponse

{
  "type": "object",
  "properties": {
    "customerPaymentMethodId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerPaymentMethodId string(uuid) false none none

CustomerPaymentMethodResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerPaymentMethodId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data CustomerPaymentMethodResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerPaymentTypeSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "Card",
        "Ach"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value Card
value Ach

CustomerProcessResponse

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid) false none none

CustomerProcessResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data CustomerProcessResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

CustomerSearchModel

{
  "type": "object",
  "properties": {
    "globalSearch": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "customerId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "name": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "description": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerAddressId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "firstName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "lastName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "company": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "addressLine1": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "addressLine2": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "city": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "country": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "state": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "postalCode": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "email": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "phone": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "fax": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "paymentType": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "Card",
                "Ach"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "updatedDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "includeDefaultAddresses": {
      "type": "boolean"
    },
    "includeDefaultPayment": {
      "type": "boolean"
    },
    "includeStats": {
      "type": "boolean"
    },
    "offSet": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "maximum": 100,
      "minimum": 1,
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
globalSearch string¦null false none none
customerId SearchFilterGuid¦null false none none
name SearchFilterString¦null false none none
description SearchFilterString¦null false none none
customerAddressId SearchFilterGuid¦null false none none
firstName SearchFilterString¦null false none none
lastName SearchFilterString¦null false none none
company SearchFilterString¦null false none none
addressLine1 SearchFilterString¦null false none none
addressLine2 SearchFilterString¦null false none none
city SearchFilterString¦null false none none
country SearchFilterString¦null false none none
state SearchFilterString¦null false none none
postalCode SearchFilterString¦null false none none
email SearchFilterString¦null false none none
phone SearchFilterString¦null false none none
fax SearchFilterString¦null false none none
paymentType CustomerPaymentTypeSearchFilterEnum¦null false none none
createdDate SearchFilterDateRange¦null false none none
updatedDate SearchFilterDateRange¦null false none none
includeDefaultAddresses boolean false none none
includeDefaultPayment boolean false none none
includeStats boolean false none none
offSet integer(int32) false none none
limit integer(int32) false none none

CustomerStat

{
  "type": "object",
  "properties": {
    "addressesCount": {
      "type": "integer",
      "format": "int32"
    },
    "paymentMethodsCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
addressesCount integer(int32) false none none
paymentMethodsCount integer(int32) false none none

CustomerUpdate

{
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "customFields": {
      "type": "array",
      "items": {
        "required": [
          "customFieldId",
          "customFieldValue"
        ],
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "customFieldValue": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string¦null false none none
customFields [CustomFieldModel]¦null false none none

GatewayAddressUpdateModel

{
  "type": "object",
  "properties": {
    "gatewayAddressId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "isPrimary": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isInvoice": {
      "type": "boolean"
    },
    "addressModel": {
      "allOf": [
        {
          "required": [
            "addressLine1",
            "firstName"
          ],
          "type": "object",
          "properties": {
            "addressLine1": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "addressLine2": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "city": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "state": {
              "maxLength": 3,
              "type": "string",
              "nullable": true
            },
            "postalCode": {
              "maxLength": 16,
              "type": "string",
              "nullable": true
            },
            "country": {
              "maxLength": 40,
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "lastName": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            },
            "email": {
              "maxLength": 100,
              "type": "string",
              "format": "email",
              "nullable": true
            },
            "phone": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "fax": {
              "maxLength": 10,
              "pattern": "^(\\d{10})$",
              "type": "string",
              "nullable": true
            },
            "company": {
              "maxLength": 50,
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayAddressId string(uuid)¦null false none none
isPrimary boolean false none none
isBilling boolean false none none
isInvoice boolean false none none
addressModel AddressModel¦null false none none

GatewayConfigurationCategoryModel

{
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string",
      "nullable": true
    },
    "code": {
      "type": "string",
      "nullable": true
    },
    "orderNumber": {
      "type": "integer",
      "format": "int32"
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "categoryId": {
                  "type": "string",
                  "format": "uuid"
                },
                "groupId": {
                  "type": "integer",
                  "format": "int32"
                },
                "label": {
                  "type": "string",
                  "nullable": true
                },
                "code": {
                  "type": "string",
                  "nullable": true
                },
                "adornmentLabel": {
                  "type": "string",
                  "nullable": true
                },
                "type": {
                  "enum": [
                    "Text",
                    "Radio",
                    "Checklist",
                    "Select",
                    "Multiselect",
                    "Switch"
                  ],
                  "type": "string"
                },
                "dataType": {
                  "type": "string",
                  "nullable": true
                },
                "orderNumber": {
                  "type": "integer",
                  "format": "int32"
                },
                "isRequired": {
                  "type": "boolean"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                },
                "options": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "label": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
displayName string¦null false none none
code string¦null false none none
orderNumber integer(int32) false none none
groups [GatewayConfigurationGroupModel]¦null false none none

GatewayConfigurationFieldEntryValueModel

{
  "required": [
    "fieldCode",
    "fieldValue"
  ],
  "type": "object",
  "properties": {
    "fieldCode": {
      "minLength": 1,
      "type": "string"
    },
    "fieldValue": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
fieldCode string true none none
fieldValue [string] true none none

GatewayConfigurationFieldModel

{
  "type": "object",
  "properties": {
    "categoryId": {
      "type": "string",
      "format": "uuid"
    },
    "groupId": {
      "type": "integer",
      "format": "int32"
    },
    "label": {
      "type": "string",
      "nullable": true
    },
    "code": {
      "type": "string",
      "nullable": true
    },
    "adornmentLabel": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "enum": [
        "Text",
        "Radio",
        "Checklist",
        "Select",
        "Multiselect",
        "Switch"
      ],
      "type": "string"
    },
    "dataType": {
      "type": "string",
      "nullable": true
    },
    "orderNumber": {
      "type": "integer",
      "format": "int32"
    },
    "isRequired": {
      "type": "boolean"
    },
    "value": {
      "type": "string",
      "nullable": true
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
categoryId string(uuid) false none none
groupId integer(int32) false none none
label string¦null false none none
code string¦null false none none
adornmentLabel string¦null false none none
type string false none none
dataType string¦null false none none
orderNumber integer(int32) false none none
isRequired boolean false none none
value string¦null false none none
options [GatewayConfigurationFieldOptionModel]¦null false none none

Enumerated Values

Property Value
type Text
type Radio
type Checklist
type Select
type Multiselect
type Switch

GatewayConfigurationFieldOptionModel

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "nullable": true
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
label string¦null false none none
value string¦null false none none

GatewayConfigurationGroupModel

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "orderNumber": {
      "type": "integer",
      "format": "int32"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "categoryId": {
            "type": "string",
            "format": "uuid"
          },
          "groupId": {
            "type": "integer",
            "format": "int32"
          },
          "label": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "adornmentLabel": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "enum": [
              "Text",
              "Radio",
              "Checklist",
              "Select",
              "Multiselect",
              "Switch"
            ],
            "type": "string"
          },
          "dataType": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "label": {
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
id integer(int32) false none none
name string¦null false none none
orderNumber integer(int32) false none none
fields [GatewayConfigurationFieldModel]¦null false none none

GatewayConfigurationModel

{
  "type": "object",
  "properties": {
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "orderNumber": {
            "type": "integer",
            "format": "int32"
          },
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "format": "int32"
                },
                "name": {
                  "type": "string",
                  "nullable": true
                },
                "orderNumber": {
                  "type": "integer",
                  "format": "int32"
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "categoryId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "groupId": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "label": {
                        "type": "string",
                        "nullable": true
                      },
                      "code": {
                        "type": "string",
                        "nullable": true
                      },
                      "adornmentLabel": {
                        "type": "string",
                        "nullable": true
                      },
                      "type": {
                        "enum": [
                          "Text",
                          "Radio",
                          "Checklist",
                          "Select",
                          "Multiselect",
                          "Switch"
                        ],
                        "type": "string"
                      },
                      "dataType": {
                        "type": "string",
                        "nullable": true
                      },
                      "orderNumber": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "isRequired": {
                        "type": "boolean"
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "label": {
                              "type": "string",
                              "nullable": true
                            },
                            "value": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        },
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "nullable": true
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
categories [GatewayConfigurationCategoryModel]¦null false none none

GatewayConfigurationModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "categories": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "orderNumber": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "groups": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "name": {
                          "type": "string",
                          "nullable": true
                        },
                        "orderNumber": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "fields": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "categoryId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "groupId": {
                                "type": "integer",
                                "format": "int32"
                              },
                              "label": {
                                "type": "string",
                                "nullable": true
                              },
                              "code": {
                                "type": "string",
                                "nullable": true
                              },
                              "adornmentLabel": {
                                "type": "string",
                                "nullable": true
                              },
                              "type": {
                                "enum": [
                                  "Text",
                                  "Radio",
                                  "Checklist",
                                  "Select",
                                  "Multiselect",
                                  "Switch"
                                ],
                                "type": "string"
                              },
                              "dataType": {
                                "type": "string",
                                "nullable": true
                              },
                              "orderNumber": {
                                "type": "integer",
                                "format": "int32"
                              },
                              "isRequired": {
                                "type": "boolean"
                              },
                              "value": {
                                "type": "string",
                                "nullable": true
                              },
                              "options": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "label": {
                                      "type": "string",
                                      "nullable": true
                                    },
                                    "value": {
                                      "type": "string",
                                      "nullable": true
                                    }
                                  },
                                  "additionalProperties": false
                                },
                                "nullable": true
                              }
                            },
                            "additionalProperties": false
                          },
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data GatewayConfigurationModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

GatewayDetailsModel

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "phoneExternal": {
      "type": "string",
      "nullable": true
    },
    "receiptEmail": {
      "type": "string",
      "nullable": true
    },
    "website": {
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "type": "string",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none
name string¦null false none none
status string false none none
phone string¦null false none none
phoneExternal string¦null false none none
receiptEmail string¦null false none none
website string¦null false none none
timezone string¦null false none none
createdDateTime string(date-time) false none none

Enumerated Values

Property Value
status Active
status Disabled

GatewaySearchModel

{
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "status": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "contactCompany": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "contactName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "contactPhoneNumber": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "contactEmail": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "maximum": 100,
      "minimum": 1,
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name SearchFilterString¦null false none none
status GatewayStatusSearchFilterEnum¦null false none none
contactCompany SearchFilterString¦null false none none
contactName SearchFilterString¦null false none none
contactPhoneNumber SearchFilterString¦null false none none
contactEmail SearchFilterString¦null false none none
createdDate SearchFilterDateRange¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none

GatewaySearchResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "contactCompany": {
      "type": "string",
      "nullable": true
    },
    "contactName": {
      "type": "string",
      "nullable": true
    },
    "contactPhoneNumber": {
      "type": "string",
      "nullable": true
    },
    "contactEmail": {
      "type": "string",
      "nullable": true
    },
    "receiptEmail": {
      "type": "string",
      "nullable": true
    },
    "sourceSystem": {
      "enum": [
        "BASYSIQ",
        "FP"
      ],
      "type": "string"
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none
name string¦null false none none
status string¦null false none none
contactCompany string¦null false none none
contactName string¦null false none none
contactPhoneNumber string¦null false none none
contactEmail string¦null false none none
receiptEmail string¦null false none none
sourceSystem string false none none
createdDateTime string(date-time) false none none

Enumerated Values

Property Value
sourceSystem BASYSIQ
sourceSystem FP

GatewaySearchResponsePagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "contactCompany": {
            "type": "string",
            "nullable": true
          },
          "contactName": {
            "type": "string",
            "nullable": true
          },
          "contactPhoneNumber": {
            "type": "string",
            "nullable": true
          },
          "contactEmail": {
            "type": "string",
            "nullable": true
          },
          "receiptEmail": {
            "type": "string",
            "nullable": true
          },
          "sourceSystem": {
            "enum": [
              "BASYSIQ",
              "FP"
            ],
            "type": "string"
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [GatewaySearchResponse]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

GatewaySearchResponsePagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "status": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactCompany": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactName": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactPhoneNumber": {
                    "type": "string",
                    "nullable": true
                  },
                  "contactEmail": {
                    "type": "string",
                    "nullable": true
                  },
                  "receiptEmail": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceSystem": {
                    "enum": [
                      "BASYSIQ",
                      "FP"
                    ],
                    "type": "string"
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data GatewaySearchResponsePagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

GatewayStatusSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "Active",
        "Disabled"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value Active
value Disabled

GatewayUserCreateModel

{
  "required": [
    "email",
    "firstName",
    "lastName",
    "phone",
    "roleId"
  ],
  "type": "object",
  "properties": {
    "email": {
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string"
    },
    "firstName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "phone": {
      "maxLength": 10,
      "minLength": 0,
      "pattern": "^(\\d{10})$",
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "permissionIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
email string true none none
firstName string true none none
lastName string true none none
phone string true none none
roleId string(uuid) true none none
permissionIds [string]¦null false none none

GatewayUserDetailsBaseModel

{
  "type": "object",
  "properties": {
    "gatewayUserId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayUserId string(uuid) false none none

GatewayUserDetailsBaseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data GatewayUserDetailsBaseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

GatewayUserDetailsBaseModelPagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gatewayUserId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [GatewayUserDetailsBaseModel]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

GatewayUserDetailsBaseModelPagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayUserId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data GatewayUserDetailsBaseModelPagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

GatewayUserGatewayDetailsModel

{
  "type": "object",
  "properties": {
    "gatewayUserId": {
      "type": "string",
      "format": "uuid"
    },
    "gateway": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "phoneExternal": {
              "type": "string",
              "nullable": true
            },
            "receiptEmail": {
              "type": "string",
              "nullable": true
            },
            "website": {
              "type": "string",
              "nullable": true
            },
            "timezone": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayUserId string(uuid) false none none
gateway GatewayDetailsModel¦null false none none

GatewayUserUpdate

{
  "required": [
    "firstName",
    "gatewayUserStatus",
    "lastName",
    "phone",
    "roleId",
    "userStatus"
  ],
  "type": "object",
  "properties": {
    "firstName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "phone": {
      "maxLength": 10,
      "minLength": 1,
      "pattern": "^(\\d{10})$",
      "type": "string"
    },
    "userStatus": {
      "enum": [
        "InvitePending",
        "PendingTOS",
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "gatewayUserStatus": {
      "enum": [
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "permissionIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
firstName string true none none
lastName string true none none
phone string true none none
userStatus string true none none
gatewayUserStatus string true none none
roleId string(uuid) true none none
permissionIds [string]¦null false none none

Enumerated Values

Property Value
userStatus InvitePending
userStatus PendingTOS
userStatus Active
userStatus Disabled
gatewayUserStatus Active
gatewayUserStatus Disabled

GetProcessorDetailsModel

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "processorId": {
      "type": "string",
      "format": "uuid"
    },
    "processorType": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorTypeId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "type": {
              "enum": [
                "CreditCard",
                "Ach"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "merchantId": {
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "type": "string",
      "nullable": true
    },
    "hour": {
      "type": "integer",
      "format": "int32"
    },
    "minute": {
      "type": "integer",
      "format": "int32"
    },
    "paymentAdjustmentTypeId": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string"
    },
    "paymentAdjustmentType": {
      "type": "string",
      "nullable": true
    },
    "paymentAdjustmentLabel": {
      "enum": [
        "NoLabel",
        "ConvenienceFee",
        "ServiceFee",
        "AdminFee",
        "ShippingHandlingFee"
      ],
      "type": "string"
    },
    "paymentAdjustmentValue": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "preferences": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "metadataId": {
            "type": "integer",
            "format": "int32"
          },
          "preferenceName": {
            "type": "string",
            "nullable": true
          },
          "metadataName": {
            "type": "string",
            "nullable": true
          },
          "metadataValue": {
            "type": "string",
            "nullable": true
          },
          "metadataDisplayName": {
            "type": "string",
            "nullable": true
          },
          "metadataDescription": {
            "type": "string",
            "nullable": true
          },
          "metadataDataType": {
            "type": "string",
            "nullable": true
          },
          "isPublic": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "settings": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "rapidOtc": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "classification": {
                      "enum": [
                        "Ecomm",
                        "MOTO",
                        "Retail"
                      ],
                      "type": "string"
                    },
                    "did": {
                      "type": "string",
                      "nullable": true
                    },
                    "visaMcc": {
                      "type": "string",
                      "nullable": true
                    },
                    "mcMcc": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "rapidHc": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "classification": {
                      "enum": [
                        "Ecomm",
                        "MOTO",
                        "Retail"
                      ],
                      "type": "string"
                    },
                    "did": {
                      "type": "string",
                      "nullable": true
                    },
                    "visaMcc": {
                      "type": "string",
                      "nullable": true
                    },
                    "mcMcc": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "tsysSierra": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "bin": {
                      "type": "string",
                      "nullable": true
                    },
                    "mid": {
                      "type": "string",
                      "nullable": true
                    },
                    "mvv": {
                      "type": "string",
                      "nullable": true
                    },
                    "agentBankNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "agentChainNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "storeNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "industryCode": {
                      "enum": [
                        "Unknown",
                        "A",
                        "B",
                        "D",
                        "F",
                        "G",
                        "H",
                        "L",
                        "O",
                        "P",
                        "R"
                      ],
                      "type": "string"
                    },
                    "currencyCode": {
                      "type": "string",
                      "nullable": true
                    },
                    "countryCode": {
                      "type": "string",
                      "nullable": true
                    },
                    "cityCode": {
                      "type": "string",
                      "nullable": true
                    },
                    "languageIndicator": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "mcc": {
                      "type": "string",
                      "nullable": true
                    },
                    "merchantName": {
                      "type": "string",
                      "nullable": true
                    },
                    "merchantLocation": {
                      "type": "string",
                      "nullable": true
                    },
                    "merchantState": {
                      "type": "string",
                      "nullable": true
                    },
                    "merchantLocationNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "classification": {
                      "enum": [
                        "Ecomm",
                        "MOTO",
                        "Retail"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "sageAch": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "terminals": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "secCode": {
                            "enum": [
                              "PPD",
                              "CCD",
                              "WEB",
                              "TEL"
                            ],
                            "type": "string"
                          },
                          "type": {
                            "enum": [
                              "OneTime",
                              "Recurring"
                            ],
                            "type": "string"
                          },
                          "dlRequired": {
                            "type": "boolean"
                          },
                          "idRequired": {
                            "type": "boolean"
                          },
                          "checkVerification": {
                            "type": "boolean"
                          },
                          "isGatewayTerminal": {
                            "type": "boolean"
                          },
                          "allowCredits": {
                            "type": "boolean"
                          },
                          "checkLimit": {
                            "type": "integer",
                            "format": "int32"
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    },
                    "hasLevel2Verification": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "features": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "hideInVirtualTerminal": {
              "type": "boolean",
              "nullable": true
            },
            "disableAutoSettle": {
              "type": "boolean",
              "nullable": true
            },
            "availableSecCodes": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "supportedPaymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "supportedCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "isDefaultCard": {
      "type": "boolean"
    },
    "isDefaultAch": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string¦null false none none
processorId string(uuid) false none none
processorType ResponseProcessorType¦null false none none
merchantId string¦null false none none
timezone string¦null false none none
hour integer(int32) false none none
minute integer(int32) false none none
paymentAdjustmentTypeId string false none none
paymentAdjustmentType string¦null false none none
paymentAdjustmentLabel string false none none
paymentAdjustmentValue number(double)¦null false none none
createdDateTime string(date-time) false none none
preferences [ResponseMetadata]¦null false none none
settings ProcessorSetting¦null false none none
features ProcessorFeatures¦null false none none
supportedPaymentMethods [string]¦null false none none
supportedCurrencies [string]¦null false none none
isDefaultCard boolean false none none
isDefaultAch boolean false none none

Enumerated Values

Property Value
paymentAdjustmentTypeId NoAdj
paymentAdjustmentTypeId Flat
paymentAdjustmentTypeId Percentage
paymentAdjustmentLabel NoLabel
paymentAdjustmentLabel ConvenienceFee
paymentAdjustmentLabel ServiceFee
paymentAdjustmentLabel AdminFee
paymentAdjustmentLabel ShippingHandlingFee

GetProcessorDetailsModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "nullable": true
            },
            "processorId": {
              "type": "string",
              "format": "uuid"
            },
            "processorType": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "processorTypeId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdDateTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "type": {
                      "enum": [
                        "CreditCard",
                        "Ach"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "timezone": {
              "type": "string",
              "nullable": true
            },
            "hour": {
              "type": "integer",
              "format": "int32"
            },
            "minute": {
              "type": "integer",
              "format": "int32"
            },
            "paymentAdjustmentTypeId": {
              "enum": [
                "NoAdj",
                "Flat",
                "Percentage"
              ],
              "type": "string"
            },
            "paymentAdjustmentType": {
              "type": "string",
              "nullable": true
            },
            "paymentAdjustmentLabel": {
              "enum": [
                "NoLabel",
                "ConvenienceFee",
                "ServiceFee",
                "AdminFee",
                "ShippingHandlingFee"
              ],
              "type": "string"
            },
            "paymentAdjustmentValue": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "preferences": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "metadataId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "preferenceName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataValue": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDisplayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDescription": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDataType": {
                    "type": "string",
                    "nullable": true
                  },
                  "isPublic": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "settings": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "rapidOtc": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "merchantId": {
                              "type": "string",
                              "nullable": true
                            },
                            "groupId": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalId": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            },
                            "did": {
                              "type": "string",
                              "nullable": true
                            },
                            "visaMcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcMcc": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "rapidHc": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "merchantId": {
                              "type": "string",
                              "nullable": true
                            },
                            "groupId": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalId": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            },
                            "did": {
                              "type": "string",
                              "nullable": true
                            },
                            "visaMcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcMcc": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "tsysSierra": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "bin": {
                              "type": "string",
                              "nullable": true
                            },
                            "mid": {
                              "type": "string",
                              "nullable": true
                            },
                            "mvv": {
                              "type": "string",
                              "nullable": true
                            },
                            "agentBankNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "agentChainNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "storeNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "terminalNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "industryCode": {
                              "enum": [
                                "Unknown",
                                "A",
                                "B",
                                "D",
                                "F",
                                "G",
                                "H",
                                "L",
                                "O",
                                "P",
                                "R"
                              ],
                              "type": "string"
                            },
                            "currencyCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "countryCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "cityCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "languageIndicator": {
                              "type": "string",
                              "nullable": true
                            },
                            "timeZone": {
                              "type": "string",
                              "nullable": true
                            },
                            "mcc": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantName": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantLocation": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantState": {
                              "type": "string",
                              "nullable": true
                            },
                            "merchantLocationNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "classification": {
                              "enum": [
                                "Ecomm",
                                "MOTO",
                                "Retail"
                              ],
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "sageAch": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "terminals": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "secCode": {
                                    "enum": [
                                      "PPD",
                                      "CCD",
                                      "WEB",
                                      "TEL"
                                    ],
                                    "type": "string"
                                  },
                                  "type": {
                                    "enum": [
                                      "OneTime",
                                      "Recurring"
                                    ],
                                    "type": "string"
                                  },
                                  "dlRequired": {
                                    "type": "boolean"
                                  },
                                  "idRequired": {
                                    "type": "boolean"
                                  },
                                  "checkVerification": {
                                    "type": "boolean"
                                  },
                                  "isGatewayTerminal": {
                                    "type": "boolean"
                                  },
                                  "allowCredits": {
                                    "type": "boolean"
                                  },
                                  "checkLimit": {
                                    "type": "integer",
                                    "format": "int32"
                                  }
                                },
                                "additionalProperties": false
                              },
                              "nullable": true
                            },
                            "hasLevel2Verification": {
                              "type": "boolean"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "features": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "hideInVirtualTerminal": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "disableAutoSettle": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "availableSecCodes": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "supportedPaymentMethods": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "supportedCurrencies": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "isDefaultCard": {
              "type": "boolean"
            },
            "isDefaultAch": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data GetProcessorDetailsModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

GetProcessorDetailsModelListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "processorId": {
            "type": "string",
            "format": "uuid"
          },
          "processorType": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "processorTypeId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "enum": [
                      "CreditCard",
                      "Ach"
                    ],
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "merchantId": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "hour": {
            "type": "integer",
            "format": "int32"
          },
          "minute": {
            "type": "integer",
            "format": "int32"
          },
          "paymentAdjustmentTypeId": {
            "enum": [
              "NoAdj",
              "Flat",
              "Percentage"
            ],
            "type": "string"
          },
          "paymentAdjustmentType": {
            "type": "string",
            "nullable": true
          },
          "paymentAdjustmentLabel": {
            "enum": [
              "NoLabel",
              "ConvenienceFee",
              "ServiceFee",
              "AdminFee",
              "ShippingHandlingFee"
            ],
            "type": "string"
          },
          "paymentAdjustmentValue": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "preferences": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "metadataId": {
                  "type": "integer",
                  "format": "int32"
                },
                "preferenceName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataValue": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDisplayName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDescription": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDataType": {
                  "type": "string",
                  "nullable": true
                },
                "isPublic": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "settings": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "rapidOtc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "rapidHc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "tsysSierra": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "bin": {
                            "type": "string",
                            "nullable": true
                          },
                          "mid": {
                            "type": "string",
                            "nullable": true
                          },
                          "mvv": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentBankNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentChainNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "storeNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "industryCode": {
                            "enum": [
                              "Unknown",
                              "A",
                              "B",
                              "D",
                              "F",
                              "G",
                              "H",
                              "L",
                              "O",
                              "P",
                              "R"
                            ],
                            "type": "string"
                          },
                          "currencyCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "countryCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "cityCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "languageIndicator": {
                            "type": "string",
                            "nullable": true
                          },
                          "timeZone": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantName": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocation": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantState": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocationNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "sageAch": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "terminals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "terminalId": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "secCode": {
                                  "enum": [
                                    "PPD",
                                    "CCD",
                                    "WEB",
                                    "TEL"
                                  ],
                                  "type": "string"
                                },
                                "type": {
                                  "enum": [
                                    "OneTime",
                                    "Recurring"
                                  ],
                                  "type": "string"
                                },
                                "dlRequired": {
                                  "type": "boolean"
                                },
                                "idRequired": {
                                  "type": "boolean"
                                },
                                "checkVerification": {
                                  "type": "boolean"
                                },
                                "isGatewayTerminal": {
                                  "type": "boolean"
                                },
                                "allowCredits": {
                                  "type": "boolean"
                                },
                                "checkLimit": {
                                  "type": "integer",
                                  "format": "int32"
                                }
                              },
                              "additionalProperties": false
                            },
                            "nullable": true
                          },
                          "hasLevel2Verification": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "features": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "hideInVirtualTerminal": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "disableAutoSettle": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "availableSecCodes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "supportedPaymentMethods": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "supportedCurrencies": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "isDefaultCard": {
            "type": "boolean"
          },
          "isDefaultAch": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [GetProcessorDetailsModel]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

IResult

{
  "type": "object",
  "additionalProperties": false
}

Properties

None

IResult`1

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data T¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertAch

{
  "type": "object",
  "properties": {
    "maskedAccount": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "accountType": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string"
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string"
    },
    "token": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "routingNumber": {
      "maxLength": 9,
      "pattern": "\\d{0,9}",
      "type": "string",
      "nullable": true
    },
    "checkNum": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedAccount string¦null false none none
accountType string false none none
secCode string false none none
token string¦null false none none
routingNumber string¦null false none none
checkNum integer(int32)¦null false none none

Enumerated Values

Property Value
accountType Checking
accountType Savings
secCode PPD
secCode CCD
secCode WEB
secCode TEL

InsertCard

{
  "type": "object",
  "properties": {
    "maskedCard": {
      "maxLength": 19,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "token": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "cardType": {
      "enum": [
        "Visa",
        "MasterCard",
        "Discover",
        "AmericanExpress",
        "Diners",
        "Jcb"
      ],
      "type": "string"
    },
    "expirationDate": {
      "maxLength": 5,
      "minLength": 0,
      "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedCard string¦null false none none
token string¦null false none none
cardType string false none none
expirationDate string¦null false none none

Enumerated Values

Property Value
cardType Visa
cardType MasterCard
cardType Discover
cardType AmericanExpress
cardType Diners
cardType Jcb

InsertCustomField

{
  "required": [
    "dataTypeId",
    "name",
    "orderNumber",
    "type"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 2,
      "type": "string"
    },
    "type": {
      "enum": [
        "Text",
        "Radio",
        "Checklist",
        "Select",
        "Multiselect"
      ],
      "type": "string"
    },
    "dataTypeId": {
      "type": "integer",
      "format": "int32"
    },
    "orderNumber": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "isRequired": {
      "type": "boolean"
    },
    "customFieldOption": {
      "type": "array",
      "items": {
        "required": [
          "label",
          "value"
        ],
        "type": "object",
        "properties": {
          "value": {
            "maxLength": 25,
            "minLength": 1,
            "type": "string"
          },
          "label": {
            "maxLength": 25,
            "minLength": 1,
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
type string true none none
dataTypeId integer(int32) true none none
orderNumber integer(int32) true none none
isRequired boolean false none none
customFieldOption [InsertCustomFieldOption]¦null false none none

Enumerated Values

Property Value
type Text
type Radio
type Checklist
type Select
type Multiselect

InsertCustomFieldCategory

{
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 2,
      "type": "string"
    },
    "description": {
      "maxLength": 100,
      "minLength": 0,
      "type": "string",
      "nullable": true
    },
    "customer": {
      "type": "boolean"
    },
    "transaction": {
      "type": "boolean"
    },
    "invoice": {
      "type": "boolean"
    },
    "customFields": {
      "type": "array",
      "items": {
        "required": [
          "dataTypeId",
          "name",
          "orderNumber",
          "type"
        ],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 100,
            "minLength": 2,
            "type": "string"
          },
          "type": {
            "enum": [
              "Text",
              "Radio",
              "Checklist",
              "Select",
              "Multiselect"
            ],
            "type": "string"
          },
          "dataTypeId": {
            "type": "integer",
            "format": "int32"
          },
          "orderNumber": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "customFieldOption": {
            "type": "array",
            "items": {
              "required": [
                "label",
                "value"
              ],
              "type": "object",
              "properties": {
                "value": {
                  "maxLength": 25,
                  "minLength": 1,
                  "type": "string"
                },
                "label": {
                  "maxLength": 25,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string¦null false none none
customer boolean false none none
transaction boolean false none none
invoice boolean false none none
customFields [InsertCustomField]¦null false none none

InsertCustomFieldCategoryResponse

{
  "type": "object",
  "properties": {
    "customFieldCategoryId": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldCategoryId integer(int32) false none none

InsertCustomFieldCategoryResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customFieldCategoryId": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertCustomFieldCategoryResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertCustomFieldOption

{
  "required": [
    "label",
    "value"
  ],
  "type": "object",
  "properties": {
    "value": {
      "maxLength": 25,
      "minLength": 1,
      "type": "string"
    },
    "label": {
      "maxLength": 25,
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
value string true none none
label string true none none

InsertCustomFieldOptionsResponse

{
  "type": "object",
  "properties": {
    "customFieldOptionId": {
      "type": "integer",
      "format": "int32"
    },
    "label": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldOptionId integer(int32) false none none
label string¦null false none none

InsertCustomFieldOptionsResponseListIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldOptionId": {
            "type": "integer",
            "format": "int32"
          },
          "label": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [InsertCustomFieldOptionsResponse]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertCustomFieldResponse

{
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldId integer(int32) false none none
name string¦null false none none

InsertCustomFieldResponseListIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [InsertCustomFieldResponse]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertCustomFields

{
  "type": "object",
  "properties": {
    "customFieldCategoryId": {
      "type": "integer",
      "format": "int32"
    },
    "insertCustomField": {
      "type": "array",
      "items": {
        "required": [
          "dataTypeId",
          "name",
          "orderNumber",
          "type"
        ],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 100,
            "minLength": 2,
            "type": "string"
          },
          "type": {
            "enum": [
              "Text",
              "Radio",
              "Checklist",
              "Select",
              "Multiselect"
            ],
            "type": "string"
          },
          "dataTypeId": {
            "type": "integer",
            "format": "int32"
          },
          "orderNumber": {
            "maximum": 2147483647,
            "minimum": 0,
            "type": "integer",
            "format": "int32"
          },
          "isRequired": {
            "type": "boolean"
          },
          "customFieldOption": {
            "type": "array",
            "items": {
              "required": [
                "label",
                "value"
              ],
              "type": "object",
              "properties": {
                "value": {
                  "maxLength": 25,
                  "minLength": 1,
                  "type": "string"
                },
                "label": {
                  "maxLength": 25,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldCategoryId integer(int32) false none none
insertCustomField [InsertCustomField]¦null false none none

InsertCustomerPayment

{
  "required": [
    "isDefault"
  ],
  "type": "object",
  "properties": {
    "card": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedCard": {
              "maxLength": 19,
              "minLength": 0,
              "type": "string",
              "nullable": true
            },
            "token": {
              "maxLength": 50,
              "minLength": 0,
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress",
                "Diners",
                "Jcb"
              ],
              "type": "string"
            },
            "expirationDate": {
              "maxLength": 5,
              "minLength": 0,
              "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "ach": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedAccount": {
              "maxLength": 50,
              "minLength": 0,
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string"
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string"
            },
            "token": {
              "maxLength": 50,
              "minLength": 0,
              "type": "string",
              "nullable": true
            },
            "routingNumber": {
              "maxLength": 9,
              "pattern": "\\d{0,9}",
              "type": "string",
              "nullable": true
            },
            "checkNum": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "isDefault": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
card InsertCard¦null false none none
ach InsertAch¦null false none none
isDefault boolean true none none

InsertGatewayAddressModel

{
  "type": "object",
  "properties": {
    "isInvoice": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "addressLine1": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "city": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "maxLength": 16,
      "type": "string",
      "nullable": true
    },
    "country": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "firstName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "email": {
      "maxLength": 100,
      "type": "string",
      "format": "email",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "fax": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "company": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isInvoice boolean false none none
isBilling boolean false none none
isPrimary boolean false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none
firstName string¦null false none none
lastName string¦null false none none
email string(email)¦null false none none
phone string¦null false none none
fax string¦null false none none
company string¦null false none none

InsertGatewayAddressResponse

{
  "type": "object",
  "properties": {
    "gatewayAddressId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayAddressId string(uuid) false none none

InsertGatewayAddressResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayAddressId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertGatewayAddressResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertGatewayModel

{
  "required": [
    "description",
    "name",
    "phone",
    "receiptEmail",
    "timezone"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 60,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9\\-&\\., ]+$",
      "type": "string"
    },
    "description": {
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "feeScheduleId": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "minLength": 1,
      "pattern": "^(\\d{10})$",
      "type": "string"
    },
    "phoneExternal": {
      "maxLength": 16,
      "type": "string",
      "nullable": true
    },
    "receiptEmail": {
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string"
    },
    "website": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "isPrimary": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isInvoice": {
            "type": "boolean"
          },
          "address": {
            "allOf": [
              {
                "required": [
                  "addressLine1",
                  "firstName"
                ],
                "type": "object",
                "properties": {
                  "addressLine1": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "addressLine2": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "maxLength": 3,
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "maxLength": 16,
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "firstName": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "lastName": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "maxLength": 100,
                    "type": "string",
                    "format": "email",
                    "nullable": true
                  },
                  "phone": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "gatewaySettings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none
feeScheduleId string¦null false none none
phone string true none none
phoneExternal string¦null false none none
receiptEmail string true none none
website string¦null false none none
timezone string true none none
addresses [AddressInsertModel]¦null false none none
gatewaySettings [InsertGatewaySetting]¦null false none none

InsertGatewayResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none

InsertGatewayResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertGatewayResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertGatewaySetting

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
code string¦null false none none
value string¦null false none none

InsertGatewayUserResponseModel

{
  "type": "object",
  "properties": {
    "gatewayUserId": {
      "type": "string",
      "format": "uuid"
    },
    "userId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayUserId string(uuid) false none none
userId string(uuid) false none none

InsertGatewayUserResponseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            },
            "userId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertGatewayUserResponseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertImage

{
  "required": [
    "data",
    "fileName"
  ],
  "type": "object",
  "properties": {
    "fileName": {
      "minLength": 1,
      "type": "string"
    },
    "data": {
      "maxLength": 1048576,
      "type": "string",
      "format": "byte"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
fileName string true none none
data string(byte) true none none

InsertInvoice

{
  "required": [
    "dueDate",
    "invoiceAddresses",
    "invoiceDate",
    "invoicePaymentMethod",
    "invoiceStatusId",
    "invoiceTypeId",
    "lineItems",
    "requireBillingInfo",
    "requireShippingInfo",
    "title",
    "vaultCustomer"
  ],
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "title": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "number": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "message": {
      "maxLength": 500,
      "type": "string",
      "nullable": true
    },
    "invoiceStatusId": {
      "type": "integer",
      "format": "int32"
    },
    "invoiceTypeId": {
      "type": "integer",
      "format": "int32"
    },
    "requireShippingInfo": {
      "type": "boolean"
    },
    "requireBillingInfo": {
      "type": "boolean"
    },
    "vaultCustomer": {
      "type": "boolean"
    },
    "invoiceDate": {
      "type": "string",
      "format": "date-time"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time"
    },
    "invoicePaymentMethod": {
      "allOf": [
        {
          "required": [
            "ach",
            "card"
          ],
          "type": "object",
          "properties": {
            "cardProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "achProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string",
              "nullable": true
            },
            "card": {
              "type": "boolean"
            },
            "ach": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "invoiceAddresses": {
      "maxItems": 3,
      "type": "array",
      "items": {
        "required": [
          "isBilling",
          "isRemittance",
          "isShipping"
        ],
        "type": "object",
        "properties": {
          "isRemittance": {
            "type": "boolean"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "firstName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "company": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "email": {
            "maxLength": 100,
            "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
            "type": "string",
            "nullable": true
          },
          "phone": {
            "maxLength": 15,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "fax": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "city": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          },
          "state": {
            "maxLength": 3,
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "maxLength": 10,
            "type": "string",
            "nullable": true
          },
          "country": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "invoiceNotifications": {
      "type": "array",
      "items": {
        "required": [
          "bcc",
          "cc",
          "invoiceNotificationMethodId",
          "mainRecipient"
        ],
        "type": "object",
        "properties": {
          "invoiceNotificationMethodId": {
            "type": "integer",
            "format": "int32"
          },
          "mainRecipient": {
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "cc": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "bcc": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "lineItems": {
      "type": "array",
      "items": {
        "required": [
          "description",
          "discount",
          "isTaxable",
          "localTaxPercent",
          "name",
          "nationalTaxPercent",
          "quantity",
          "unitPrice"
        ],
        "type": "object",
        "properties": {
          "name": {
            "maxLength": 50,
            "minLength": 1,
            "type": "string"
          },
          "description": {
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "quantity": {
            "type": "integer",
            "format": "int32"
          },
          "unitPrice": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double"
          },
          "discount": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double"
          },
          "shippedAmount": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "freightAmount": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "unitOfMeasureId": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "isTaxable": {
            "type": "boolean"
          },
          "localTaxPercent": {
            "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
            "type": "number",
            "format": "double"
          },
          "nationalTaxPercent": {
            "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      }
    },
    "customFields": {
      "type": "array",
      "items": {
        "required": [
          "customFieldId",
          "customFieldValue"
        ],
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "customFieldValue": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid)¦null false none none
title string true none none
number string¦null false none none
message string¦null false none none
invoiceStatusId integer(int32) true none none
invoiceTypeId integer(int32) true none none
requireShippingInfo boolean true none none
requireBillingInfo boolean true none none
vaultCustomer boolean true none none
invoiceDate string(date-time) true none none
dueDate string(date-time) true none none
invoicePaymentMethod InsertInvoicePaymentMethod true none none
invoiceAddresses [InsertInvoiceAddress] true none none
invoiceNotifications [InsertInvoiceNotification]¦null false none none
lineItems [InsertLineItem] true none none
customFields [CustomFieldModel]¦null false none none

InsertInvoiceAddress

{
  "required": [
    "isBilling",
    "isRemittance",
    "isShipping"
  ],
  "type": "object",
  "properties": {
    "isRemittance": {
      "type": "boolean"
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "firstName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "company": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "email": {
      "maxLength": 100,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string",
      "nullable": true
    },
    "phone": {
      "maxLength": 15,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "fax": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "addressLine1": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "city": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "maxLength": 10,
      "type": "string",
      "nullable": true
    },
    "country": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isRemittance boolean true none none
isShipping boolean true none none
isBilling boolean true none none
firstName string¦null false none none
lastName string¦null false none none
company string¦null false none none
email string¦null false none none
phone string¦null false none none
fax string¦null false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none

InsertInvoiceNotification

{
  "required": [
    "bcc",
    "cc",
    "invoiceNotificationMethodId",
    "mainRecipient"
  ],
  "type": "object",
  "properties": {
    "invoiceNotificationMethodId": {
      "type": "integer",
      "format": "int32"
    },
    "mainRecipient": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "bcc": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceNotificationMethodId integer(int32) true none none
mainRecipient string true none none
cc [string] true none none
bcc [string] true none none

InsertInvoicePaymentMethod

{
  "required": [
    "ach",
    "card"
  ],
  "type": "object",
  "properties": {
    "cardProcessorId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "achProcessorId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string",
      "nullable": true
    },
    "card": {
      "type": "boolean"
    },
    "ach": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cardProcessorId string(uuid)¦null false none none
achProcessorId string(uuid)¦null false none none
secCode string¦null false none none
card boolean true none none
ach boolean true none none

Enumerated Values

Property Value
secCode PPD
secCode CCD
secCode WEB
secCode TEL

InsertInvoiceTransaction

{
  "required": [
    "transactionPaymentMethod",
    "transactionRemit"
  ],
  "type": "object",
  "properties": {
    "description": {
      "maxLength": 255,
      "type": "string",
      "nullable": true
    },
    "transactionPaymentMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "card": {
              "allOf": [
                {
                  "required": [
                    "cardToken",
                    "maskedNumber"
                  ],
                  "type": "object",
                  "properties": {
                    "cardToken": {
                      "maxLength": 50,
                      "minLength": 1,
                      "type": "string"
                    },
                    "cardType": {
                      "enum": [
                        "Visa",
                        "MasterCard",
                        "Discover",
                        "AmericanExpress"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "expirationDate": {
                      "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                      "type": "string",
                      "nullable": true
                    },
                    "maskedNumber": {
                      "minLength": 1,
                      "pattern": "^\\d{6}\\*{6,}\\d{4}$",
                      "type": "string"
                    },
                    "entryType": {
                      "enum": [
                        "Swiped",
                        "Keyed",
                        "Contact",
                        "Contactless"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "ach": {
              "allOf": [
                {
                  "required": [
                    "achToken"
                  ],
                  "type": "object",
                  "properties": {
                    "achToken": {
                      "maxLength": 50,
                      "minLength": 1,
                      "type": "string"
                    },
                    "secCode": {
                      "enum": [
                        "PPD",
                        "CCD",
                        "WEB",
                        "TEL"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "routingNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountType": {
                      "enum": [
                        "Checking",
                        "Savings"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "checkNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountHolderAuth": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "dlState": {
                              "type": "string",
                              "nullable": true
                            },
                            "dlNumber": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionRemit": {
      "allOf": [
        {
          "required": [
            "baseAmount",
            "currencyCode"
          ],
          "type": "object",
          "properties": {
            "baseAmount": {
              "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
              "type": "number",
              "format": "double"
            },
            "currencyCode": {
              "enum": [
                "USD"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionAddress": {
      "type": "array",
      "items": {
        "required": [
          "isBilling",
          "isPhysical",
          "isShipping"
        ],
        "type": "object",
        "properties": {
          "isPhysical": {
            "type": "boolean"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "firstName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "company": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "email": {
            "maxLength": 100,
            "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
            "type": "string",
            "nullable": true
          },
          "phone": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "fax": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "city": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          },
          "state": {
            "maxLength": 3,
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "maxLength": 10,
            "type": "string",
            "nullable": true
          },
          "country": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "emailReceipt": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
description string¦null false none none
transactionPaymentMethod InvoiceTransactionPaymentMethod true none none
transactionRemit InvoiceTransactionRemit true none none
transactionAddress [TransactionAddress]¦null false none none
emailReceipt boolean false none none

InsertLineItem

{
  "required": [
    "description",
    "discount",
    "isTaxable",
    "localTaxPercent",
    "name",
    "nationalTaxPercent",
    "quantity",
    "unitPrice"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "quantity": {
      "type": "integer",
      "format": "int32"
    },
    "unitPrice": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double"
    },
    "discount": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double"
    },
    "shippedAmount": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "freightAmount": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "unitOfMeasureId": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "isTaxable": {
      "type": "boolean"
    },
    "localTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "nationalTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none
quantity integer(int32) true none none
unitPrice number(double) true none none
discount number(double) true none none
shippedAmount number(double)¦null false none none
freightAmount number(double)¦null false none none
unitOfMeasureId integer(int32)¦null false none none
isTaxable boolean true none none
localTaxPercent number(double) true none none
nationalTaxPercent number(double) true none none

InsertProcessorModel

{
  "required": [
    "name",
    "paymentAdjustmentType",
    "paymentAdjustmentValue",
    "processorType",
    "sourceId",
    "timezone"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "processorType": {
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "settleAt": {
      "type": "string",
      "format": "date-span"
    },
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string"
    },
    "paymentAdjustmentValue": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "sourceId": {
      "minLength": 1,
      "type": "string"
    },
    "isDefaultCard": {
      "type": "boolean"
    },
    "isDefaultAch": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
processorType string true none none
description string¦null false none none
timezone string true none none
settleAt string(date-span) false none none
paymentAdjustmentType string true none none
paymentAdjustmentValue number(double) true none none
sourceId string true none none
isDefaultCard boolean false none none
isDefaultAch boolean false none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage

InsertProcessorResponse

{
  "type": "object",
  "properties": {
    "processorId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
processorId string(uuid) false none none

InsertProcessorResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertProcessorResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertProduct

{
  "required": [
    "name",
    "unitPrice"
  ],
  "type": "object",
  "properties": {
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "unitPrice": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "unitOfMeasureId": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "image": {
      "allOf": [
        {
          "required": [
            "data",
            "fileName"
          ],
          "type": "object",
          "properties": {
            "fileName": {
              "minLength": 1,
              "type": "string"
            },
            "data": {
              "maxLength": 1048576,
              "type": "string",
              "format": "byte"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "localTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "nationalTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
description string¦null false none none
unitPrice number(double) true none none
unitOfMeasureId integer(int32)¦null false none none
image InsertImage¦null false none none
localTaxPercent number(double) false none none
nationalTaxPercent number(double) false none none

InsertSavedSearchRequest

{
  "required": [
    "name",
    "type",
    "value"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "schemaVersion": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "enum": [
        "Transaction",
        "Settlement",
        "Customer"
      ],
      "type": "string"
    },
    "value": {
      "maxLength": 4000,
      "minLength": 1,
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
schemaVersion string¦null false none none
type string true none none
value string true none none

Enumerated Values

Property Value
type Transaction
type Settlement
type Customer

InsertSavedSearchResponse

{
  "type": "object",
  "properties": {
    "savedSearchId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
savedSearchId string(uuid) false none none

InsertSavedSearchResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data InsertSavedSearchResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

InsertTransaction

{
  "required": [
    "emailReceipt",
    "processorId",
    "transactionPaymentMethod",
    "transactionRemit",
    "transactionSource",
    "type"
  ],
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "Sale",
        "Authorize",
        "Capture",
        "Credit",
        "Refund",
        "Verification"
      ],
      "type": "string"
    },
    "orderId": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "poNumber": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "description": {
      "maxLength": 255,
      "type": "string",
      "nullable": true
    },
    "transactionSource": {
      "enum": [
        "Cp",
        "Webhook",
        "Api",
        "Batch",
        "Invoice",
        "Cart",
        "Recurring"
      ],
      "type": "string"
    },
    "vaultCustomer": {
      "type": "boolean"
    },
    "customerName": {
      "type": "string",
      "nullable": true
    },
    "emailReceipt": {
      "type": "boolean"
    },
    "emailAddress": {
      "maxLength": 100,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string",
      "nullable": true
    },
    "transactionPaymentMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "card": {
              "allOf": [
                {
                  "required": [
                    "cardToken",
                    "maskedNumber"
                  ],
                  "type": "object",
                  "properties": {
                    "cardToken": {
                      "maxLength": 50,
                      "minLength": 1,
                      "type": "string"
                    },
                    "cardType": {
                      "enum": [
                        "Visa",
                        "MasterCard",
                        "Discover",
                        "AmericanExpress"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "expirationDate": {
                      "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
                      "type": "string",
                      "nullable": true
                    },
                    "maskedNumber": {
                      "minLength": 1,
                      "pattern": "^\\d{6}\\*{6,}\\d{4}$",
                      "type": "string"
                    },
                    "entryType": {
                      "enum": [
                        "Swiped",
                        "Keyed",
                        "Contact",
                        "Contactless"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "ach": {
              "allOf": [
                {
                  "required": [
                    "achToken"
                  ],
                  "type": "object",
                  "properties": {
                    "achToken": {
                      "maxLength": 50,
                      "minLength": 1,
                      "type": "string"
                    },
                    "secCode": {
                      "enum": [
                        "PPD",
                        "CCD",
                        "WEB",
                        "TEL"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "routingNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountType": {
                      "enum": [
                        "Checking",
                        "Savings"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "checkNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountHolderAuth": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "dlState": {
                              "type": "string",
                              "nullable": true
                            },
                            "dlNumber": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "required": [
                    "customerId"
                  ],
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "customerPaymentMethodId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "customerBillingAddressId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "customerShippingAddressId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "processorId": {
      "type": "string",
      "format": "uuid"
    },
    "transactionRemit": {
      "allOf": [
        {
          "required": [
            "baseAmount",
            "currencyCode",
            "taxAmount"
          ],
          "type": "object",
          "properties": {
            "baseAmount": {
              "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
              "type": "number",
              "format": "double"
            },
            "taxAmount": {
              "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
              "type": "number",
              "format": "double"
            },
            "isTaxExempt": {
              "type": "boolean"
            },
            "currencyCode": {
              "enum": [
                "USD"
              ],
              "type": "string"
            },
            "addTaxToTotal": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "transactionAddress": {
      "maxItems": 2,
      "type": "array",
      "items": {
        "required": [
          "isBilling",
          "isPhysical",
          "isShipping"
        ],
        "type": "object",
        "properties": {
          "isPhysical": {
            "type": "boolean"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "firstName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "company": {
            "maxLength": 50,
            "type": "string",
            "nullable": true
          },
          "email": {
            "maxLength": 100,
            "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
            "type": "string",
            "nullable": true
          },
          "phone": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "fax": {
            "maxLength": 10,
            "pattern": "^(\\d{10})$",
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "maxLength": 100,
            "type": "string",
            "nullable": true
          },
          "city": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          },
          "state": {
            "maxLength": 3,
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "maxLength": 10,
            "type": "string",
            "nullable": true
          },
          "country": {
            "maxLength": 40,
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "transactionPaymentAdjustment": {
      "allOf": [
        {
          "required": [
            "paymentAdjustmentType",
            "paymentAdjustmentValue"
          ],
          "type": "object",
          "properties": {
            "paymentAdjustmentType": {
              "enum": [
                "NoAdj",
                "Flat",
                "Percentage"
              ],
              "type": "string"
            },
            "paymentAdjustmentValue": {
              "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
              "type": "number",
              "format": "double"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customFields": {
      "type": "array",
      "items": {
        "required": [
          "customFieldId",
          "customFieldValue"
        ],
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "customFieldValue": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "invoiceId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "cardPresentPayload": {
      "allOf": [
        {
          "required": [
            "dataWireId",
            "groupId",
            "merchantId",
            "terminalId",
            "transaction"
          ],
          "type": "object",
          "properties": {
            "transaction": {
              "allOf": [
                {
                  "required": [
                    "tenderData",
                    "transactionData"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderData": {
                      "allOf": [
                        {
                          "required": [
                            "tenderType"
                          ],
                          "type": "object",
                          "properties": {
                            "tenderType": {
                              "enum": [
                                "ProcessAsCredit",
                                "ProcessAsDebit"
                              ],
                              "type": "string"
                            },
                            "cardSecurityData": {
                              "allOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "cvData": {
                                      "type": "string",
                                      "nullable": true
                                    }
                                  },
                                  "additionalProperties": false
                                }
                              ],
                              "nullable": true
                            },
                            "trackTwoSecondHalf": {
                              "type": "string",
                              "nullable": true
                            },
                            "emvTlv": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    },
                    "transactionData": {
                      "allOf": [
                        {
                          "required": [
                            "timeZone",
                            "transactionId",
                            "transactionIsoDate"
                          ],
                          "type": "object",
                          "properties": {
                            "transactionIsoDate": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "timeZone": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "transactionId": {
                              "type": "string",
                              "format": "uuid"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "merchantId": {
              "minLength": 1,
              "type": "string"
            },
            "dataWireId": {
              "minLength": 1,
              "type": "string"
            },
            "terminalId": {
              "minLength": 1,
              "type": "string"
            },
            "groupId": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
type string true none none
orderId string¦null false none none
poNumber string¦null false none none
description string¦null false none none
transactionSource string true none none
vaultCustomer boolean false none none
customerName string¦null false none none
emailReceipt boolean true none none
emailAddress string¦null false none none
transactionPaymentMethod TransactionPaymentMethod true none none
processorId string(uuid) true none none
transactionRemit TransactionRemit true none none
transactionAddress [TransactionAddress]¦null false none none
transactionPaymentAdjustment TransactionPaymentAdjustment¦null false none none
customFields [CustomFieldModel]¦null false none none
invoiceId string(uuid)¦null false none none
cardPresentPayload CardPresentPayload¦null false none none

Enumerated Values

Property Value
type Sale
type Authorize
type Capture
type Credit
type Refund
type Verification
transactionSource Cp
transactionSource Webhook
transactionSource Api
transactionSource Batch
transactionSource Invoice
transactionSource Cart
transactionSource Recurring

InsertTransactionCustomer

{
  "type": "object",
  "properties": {
    "customerName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "description": {
      "maxLength": 255,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerName string¦null false none none
description string¦null false none none

InvoiceFeesModel

{
  "type": "object",
  "properties": {
    "lineItems": {
      "type": "array",
      "items": {
        "required": [
          "discount",
          "quantity",
          "unitPrice"
        ],
        "type": "object",
        "properties": {
          "quantity": {
            "type": "integer",
            "format": "int32"
          },
          "unitPrice": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double"
          },
          "discount": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double"
          },
          "freightAmount": {
            "pattern": "^\\d+(\\.\\d{1,2})?$",
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "localTaxPercent": {
            "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "nationalTaxPercent": {
            "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "isTaxable": {
            "type": "boolean",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "shippingState": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
lineItems [LineItemFees]¦null false none none
shippingState string¦null false none none

InvoiceTransactionPaymentMethod

{
  "type": "object",
  "properties": {
    "card": {
      "allOf": [
        {
          "required": [
            "cardToken",
            "maskedNumber"
          ],
          "type": "object",
          "properties": {
            "cardToken": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress"
              ],
              "type": "string",
              "nullable": true
            },
            "expirationDate": {
              "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
              "type": "string",
              "nullable": true
            },
            "maskedNumber": {
              "minLength": 1,
              "pattern": "^\\d{6}\\*{6,}\\d{4}$",
              "type": "string"
            },
            "entryType": {
              "enum": [
                "Swiped",
                "Keyed",
                "Contact",
                "Contactless"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "ach": {
      "allOf": [
        {
          "required": [
            "achToken"
          ],
          "type": "object",
          "properties": {
            "achToken": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string",
              "nullable": true
            },
            "routingNumber": {
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string",
              "nullable": true
            },
            "checkNumber": {
              "type": "string",
              "nullable": true
            },
            "accountHolderAuth": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "dlState": {
                      "type": "string",
                      "nullable": true
                    },
                    "dlNumber": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
card TransactionCard¦null false none none
ach TransactionAch¦null false none none

InvoiceTransactionRemit

{
  "required": [
    "baseAmount",
    "currencyCode"
  ],
  "type": "object",
  "properties": {
    "baseAmount": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "currencyCode": {
      "enum": [
        "USD"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
baseAmount number(double) true none none
currencyCode string true none none

Enumerated Values

Property Value
currencyCode USD

LineItemFees

{
  "required": [
    "discount",
    "quantity",
    "unitPrice"
  ],
  "type": "object",
  "properties": {
    "quantity": {
      "type": "integer",
      "format": "int32"
    },
    "unitPrice": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double"
    },
    "discount": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double"
    },
    "freightAmount": {
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "localTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "nationalTaxPercent": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "isTaxable": {
      "type": "boolean",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
quantity integer(int32) true none none
unitPrice number(double) true none none
discount number(double) true none none
freightAmount number(double)¦null false none none
localTaxPercent number(double)¦null false none none
nationalTaxPercent number(double)¦null false none none
isTaxable boolean¦null false none none

ObjectIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data any false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

Operation

{
  "type": "object",
  "properties": {
    "value": {
      "nullable": true
    },
    "path": {
      "type": "string",
      "nullable": true
    },
    "op": {
      "type": "string",
      "nullable": true
    },
    "from": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
value any false none none
path string¦null false none none
op string¦null false none none
from string¦null false none none

PatchCustomFieldResponse

{
  "type": "object",
  "properties": {
    "customFieldId": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldId integer(int32) false none none

PatchCustomFieldResponseListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [PatchCustomFieldResponse]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

PatchGatewayResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none

PatchGatewayResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data PatchGatewayResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

PaymentMethodModel

{
  "type": "object",
  "properties": {
    "ach": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "achId": {
              "type": "string",
              "format": "uuid"
            },
            "maskedAccount": {
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string"
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string"
            },
            "token": {
              "type": "string",
              "nullable": true
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "card": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cardId": {
              "type": "string",
              "format": "uuid"
            },
            "maskedCard": {
              "type": "string",
              "nullable": true
            },
            "token": {
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress"
              ],
              "type": "string"
            },
            "expirationDate": {
              "type": "string",
              "nullable": true
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "isDefault": {
      "type": "boolean"
    },
    "paymentMethodId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
ach AchResponse¦null false none none
card CardResponse¦null false none none
isDefault boolean false none none
paymentMethodId string(uuid) false none none

ProblemDetails

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": {}
}

Properties

Name Type Required Restrictions Description
additionalProperties any false none none
type string¦null false none none
title string¦null false none none
status integer(int32)¦null false none none
detail string¦null false none none
instance string¦null false none none

ProcessTransactionResponse

{
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "format": "uuid"
    },
    "processorResponseCode": {
      "type": "string",
      "nullable": true
    },
    "processorResponseText": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "Unknown",
        "Declined",
        "Authorized",
        "PendingSettlement",
        "Settled",
        "Voided",
        "Refunded",
        "Returned",
        "LateReturn",
        "Pending",
        "PartiallyRefunded"
      ],
      "type": "string",
      "nullable": true
    },
    "response": {
      "type": "string",
      "nullable": true
    },
    "responseCode": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "appliedToBalanceAmount": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "remainingBalance": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "transactionTotal": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "cardPresentResponse": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "dataWireId": {
              "type": "string",
              "nullable": true
            },
            "terminalId": {
              "type": "string",
              "nullable": true
            },
            "groupId": {
              "type": "string",
              "nullable": true
            },
            "timeZone": {
              "type": "string",
              "nullable": true
            },
            "cardBrand": {
              "type": "string",
              "nullable": true
            },
            "token": {
              "type": "string",
              "nullable": true
            },
            "expireDate": {
              "type": "string",
              "nullable": true
            },
            "transaction": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "transactionType": {
                      "type": "string",
                      "nullable": true
                    },
                    "transactionId": {
                      "type": "string",
                      "nullable": true
                    },
                    "referenceNumber": {
                      "type": "string",
                      "nullable": true
                    },
                    "referenceIsoDateTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "stan": {
                      "type": "string",
                      "nullable": true
                    },
                    "responseCode": {
                      "enum": [
                        "UNKN",
                        "DECL",
                        "APPR"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "responseReason": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardResponse": {
                      "type": "string",
                      "nullable": true
                    },
                    "authCode": {
                      "type": "string",
                      "nullable": true
                    },
                    "completionRequired": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "approvedAmount": {
                      "type": "number",
                      "format": "double",
                      "nullable": true
                    },
                    "currency": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionId string(uuid) false none none
processorResponseCode string¦null false none none
processorResponseText string¦null false none none
status string¦null false none none
response string¦null false none none
responseCode integer(int32)¦null false none none
appliedToBalanceAmount number(double)¦null false none none
remainingBalance number(double)¦null false none none
transactionTotal number(double)¦null false none none
cardPresentResponse CardPresentResponse¦null false none none

Enumerated Values

Property Value
status Unknown
status Declined
status Authorized
status PendingSettlement
status Settled
status Voided
status Refunded
status Returned
status LateReturn
status Pending
status PartiallyRefunded

ProcessTransactionResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string",
              "nullable": true
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "appliedToBalanceAmount": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "transactionTotal": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cardPresentResponse": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "merchantId": {
                      "type": "string",
                      "nullable": true
                    },
                    "dataWireId": {
                      "type": "string",
                      "nullable": true
                    },
                    "terminalId": {
                      "type": "string",
                      "nullable": true
                    },
                    "groupId": {
                      "type": "string",
                      "nullable": true
                    },
                    "timeZone": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardBrand": {
                      "type": "string",
                      "nullable": true
                    },
                    "token": {
                      "type": "string",
                      "nullable": true
                    },
                    "expireDate": {
                      "type": "string",
                      "nullable": true
                    },
                    "transaction": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "transactionType": {
                              "type": "string",
                              "nullable": true
                            },
                            "transactionId": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceNumber": {
                              "type": "string",
                              "nullable": true
                            },
                            "referenceIsoDateTime": {
                              "type": "string",
                              "format": "date-time"
                            },
                            "stan": {
                              "type": "string",
                              "nullable": true
                            },
                            "responseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string",
                              "nullable": true
                            },
                            "responseReason": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardResponse": {
                              "type": "string",
                              "nullable": true
                            },
                            "authCode": {
                              "type": "string",
                              "nullable": true
                            },
                            "completionRequired": {
                              "type": "boolean",
                              "nullable": true
                            },
                            "approvedAmount": {
                              "type": "number",
                              "format": "double",
                              "nullable": true
                            },
                            "currency": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ProcessTransactionResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ProcessorFeatures

{
  "type": "object",
  "properties": {
    "hideInVirtualTerminal": {
      "type": "boolean",
      "nullable": true
    },
    "disableAutoSettle": {
      "type": "boolean",
      "nullable": true
    },
    "availableSecCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
hideInVirtualTerminal boolean¦null false none none
disableAutoSettle boolean¦null false none none
availableSecCodes [string]¦null false none none

ProcessorSetting

{
  "type": "object",
  "properties": {
    "rapidOtc": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "groupId": {
              "type": "string",
              "nullable": true
            },
            "terminalId": {
              "type": "string",
              "nullable": true
            },
            "classification": {
              "enum": [
                "Ecomm",
                "MOTO",
                "Retail"
              ],
              "type": "string"
            },
            "did": {
              "type": "string",
              "nullable": true
            },
            "visaMcc": {
              "type": "string",
              "nullable": true
            },
            "mcMcc": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "rapidHc": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "groupId": {
              "type": "string",
              "nullable": true
            },
            "terminalId": {
              "type": "string",
              "nullable": true
            },
            "classification": {
              "enum": [
                "Ecomm",
                "MOTO",
                "Retail"
              ],
              "type": "string"
            },
            "did": {
              "type": "string",
              "nullable": true
            },
            "visaMcc": {
              "type": "string",
              "nullable": true
            },
            "mcMcc": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "tsysSierra": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "bin": {
              "type": "string",
              "nullable": true
            },
            "mid": {
              "type": "string",
              "nullable": true
            },
            "mvv": {
              "type": "string",
              "nullable": true
            },
            "agentBankNumber": {
              "type": "string",
              "nullable": true
            },
            "agentChainNumber": {
              "type": "string",
              "nullable": true
            },
            "storeNumber": {
              "type": "string",
              "nullable": true
            },
            "terminalNumber": {
              "type": "string",
              "nullable": true
            },
            "industryCode": {
              "enum": [
                "Unknown",
                "A",
                "B",
                "D",
                "F",
                "G",
                "H",
                "L",
                "O",
                "P",
                "R"
              ],
              "type": "string"
            },
            "currencyCode": {
              "type": "string",
              "nullable": true
            },
            "countryCode": {
              "type": "string",
              "nullable": true
            },
            "cityCode": {
              "type": "string",
              "nullable": true
            },
            "languageIndicator": {
              "type": "string",
              "nullable": true
            },
            "timeZone": {
              "type": "string",
              "nullable": true
            },
            "mcc": {
              "type": "string",
              "nullable": true
            },
            "merchantName": {
              "type": "string",
              "nullable": true
            },
            "merchantLocation": {
              "type": "string",
              "nullable": true
            },
            "merchantState": {
              "type": "string",
              "nullable": true
            },
            "merchantLocationNumber": {
              "type": "string",
              "nullable": true
            },
            "classification": {
              "enum": [
                "Ecomm",
                "MOTO",
                "Retail"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "sageAch": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "terminals": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "terminalId": {
                    "type": "string",
                    "nullable": true
                  },
                  "secCode": {
                    "enum": [
                      "PPD",
                      "CCD",
                      "WEB",
                      "TEL"
                    ],
                    "type": "string"
                  },
                  "type": {
                    "enum": [
                      "OneTime",
                      "Recurring"
                    ],
                    "type": "string"
                  },
                  "dlRequired": {
                    "type": "boolean"
                  },
                  "idRequired": {
                    "type": "boolean"
                  },
                  "checkVerification": {
                    "type": "boolean"
                  },
                  "isGatewayTerminal": {
                    "type": "boolean"
                  },
                  "allowCredits": {
                    "type": "boolean"
                  },
                  "checkLimit": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "hasLevel2Verification": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
rapidOtc RapidOtcSetting¦null false none none
rapidHc RapidHcSetting¦null false none none
tsysSierra TsysSierraSetting¦null false none none
sageAch SageAchSetting¦null false none none

ProductSearchRequest

{
  "type": "object",
  "properties": {
    "productId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "name": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "description": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "sortColumn": {
      "type": "string",
      "nullable": true
    },
    "sortDirection": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
productId SearchFilterGuid¦null false none none
name SearchFilterString¦null false none none
description SearchFilterString¦null false none none
createdDateTime SearchFilterDateRange¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none
sortColumn string¦null false none none
sortDirection string¦null false none none

RapidHcSetting

{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string",
      "nullable": true
    },
    "groupId": {
      "type": "string",
      "nullable": true
    },
    "terminalId": {
      "type": "string",
      "nullable": true
    },
    "classification": {
      "enum": [
        "Ecomm",
        "MOTO",
        "Retail"
      ],
      "type": "string"
    },
    "did": {
      "type": "string",
      "nullable": true
    },
    "visaMcc": {
      "type": "string",
      "nullable": true
    },
    "mcMcc": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
merchantId string¦null false none none
groupId string¦null false none none
terminalId string¦null false none none
classification string false none none
did string¦null false none none
visaMcc string¦null false none none
mcMcc string¦null false none none

Enumerated Values

Property Value
classification Ecomm
classification MOTO
classification Retail

RapidOtcSetting

{
  "type": "object",
  "properties": {
    "merchantId": {
      "type": "string",
      "nullable": true
    },
    "groupId": {
      "type": "string",
      "nullable": true
    },
    "terminalId": {
      "type": "string",
      "nullable": true
    },
    "classification": {
      "enum": [
        "Ecomm",
        "MOTO",
        "Retail"
      ],
      "type": "string"
    },
    "did": {
      "type": "string",
      "nullable": true
    },
    "visaMcc": {
      "type": "string",
      "nullable": true
    },
    "mcMcc": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
merchantId string¦null false none none
groupId string¦null false none none
terminalId string¦null false none none
classification string false none none
did string¦null false none none
visaMcc string¦null false none none
mcMcc string¦null false none none

Enumerated Values

Property Value
classification Ecomm
classification MOTO
classification Retail

ReadAchConfiguration

{
  "type": "object",
  "properties": {
    "iqProV2": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "achUrl": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
iqProV2 ReadIqProVaultConfiguration¦null false none none

ReadApiConfiguration

{
  "type": "object",
  "properties": {
    "iqProV2": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string",
              "nullable": true
            },
            "tokenizationId": {
              "type": "string",
              "nullable": true
            },
            "tokenScheme": {
              "type": "string",
              "nullable": true
            },
            "authenticationKey": {
              "type": "string",
              "nullable": true
            },
            "pci": {
              "type": "boolean"
            },
            "expires": {
              "type": "string",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
iqProV2 ReadTokenExApiConfiguration¦null false none none

ReadFpIframeConfiguration

{
  "type": "object",
  "properties": {
    "publicKey": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
publicKey string¦null false none none

ReadIframeConfiguration

{
  "type": "object",
  "properties": {
    "iqPro": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "publicKey": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "iqProV2": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "origin": {
              "type": "string",
              "nullable": true
            },
            "timestamp": {
              "type": "string",
              "nullable": true
            },
            "tokenizationId": {
              "type": "string",
              "nullable": true
            },
            "tokenScheme": {
              "type": "string",
              "nullable": true
            },
            "authenticationKey": {
              "type": "string",
              "nullable": true
            },
            "pci": {
              "type": "boolean"
            },
            "expires": {
              "type": "string",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
iqPro ReadFpIframeConfiguration¦null false none none
iqProV2 ReadTokenExIframeConfiguration¦null false none none

ReadIqProVaultConfiguration

{
  "type": "object",
  "properties": {
    "achUrl": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
achUrl string¦null false none none

ReadMobileConfiguration

{
  "type": "object",
  "properties": {
    "iqProV2": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string",
              "nullable": true
            },
            "tokenizationId": {
              "type": "string",
              "nullable": true
            },
            "tokenScheme": {
              "type": "string",
              "nullable": true
            },
            "authenticationKey": {
              "type": "string",
              "nullable": true
            },
            "pci": {
              "type": "boolean"
            },
            "expires": {
              "type": "string",
              "format": "date-time"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
iqProV2 ReadTokenExApiConfiguration¦null false none none

ReadProxyConfiguration

{
  "type": "object",
  "properties": {
    "iqProV2": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "tokenizationId": {
              "type": "string",
              "nullable": true
            },
            "profiles": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "profileName": {
                    "type": "string",
                    "nullable": true
                  },
                  "url": {
                    "type": "string",
                    "nullable": true
                  },
                  "profileKey": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
iqProV2 ReadTokenExProxyConfiguration¦null false none none

ReadTokenExApiConfiguration

{
  "type": "object",
  "properties": {
    "timestamp": {
      "type": "string",
      "nullable": true
    },
    "tokenizationId": {
      "type": "string",
      "nullable": true
    },
    "tokenScheme": {
      "type": "string",
      "nullable": true
    },
    "authenticationKey": {
      "type": "string",
      "nullable": true
    },
    "pci": {
      "type": "boolean"
    },
    "expires": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
timestamp string¦null false none none
tokenizationId string¦null false none none
tokenScheme string¦null false none none
authenticationKey string¦null false none none
pci boolean false none none
expires string(date-time) false none none

ReadTokenExIframeConfiguration

{
  "type": "object",
  "properties": {
    "origin": {
      "type": "string",
      "nullable": true
    },
    "timestamp": {
      "type": "string",
      "nullable": true
    },
    "tokenizationId": {
      "type": "string",
      "nullable": true
    },
    "tokenScheme": {
      "type": "string",
      "nullable": true
    },
    "authenticationKey": {
      "type": "string",
      "nullable": true
    },
    "pci": {
      "type": "boolean"
    },
    "expires": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
origin string¦null false none none
timestamp string¦null false none none
tokenizationId string¦null false none none
tokenScheme string¦null false none none
authenticationKey string¦null false none none
pci boolean false none none
expires string(date-time) false none none

ReadTokenExProxyConfiguration

{
  "type": "object",
  "properties": {
    "tokenizationId": {
      "type": "string",
      "nullable": true
    },
    "profiles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "profileName": {
            "type": "string",
            "nullable": true
          },
          "url": {
            "type": "string",
            "nullable": true
          },
          "profileKey": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
tokenizationId string¦null false none none
profiles [ReadTokenExProxyProfile]¦null false none none

ReadTokenExProxyProfile

{
  "type": "object",
  "properties": {
    "profileName": {
      "type": "string",
      "nullable": true
    },
    "url": {
      "type": "string",
      "nullable": true
    },
    "profileKey": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
profileName string¦null false none none
url string¦null false none none
profileKey string¦null false none none

ReadTokenizationConfiguration

{
  "type": "object",
  "properties": {
    "cardTokenizer": {
      "type": "string",
      "nullable": true
    },
    "achTokenizer": {
      "type": "string",
      "nullable": true
    },
    "iframeConfiguration": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "iqPro": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "publicKey": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "iqProV2": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "origin": {
                      "type": "string",
                      "nullable": true
                    },
                    "timestamp": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenizationId": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenScheme": {
                      "type": "string",
                      "nullable": true
                    },
                    "authenticationKey": {
                      "type": "string",
                      "nullable": true
                    },
                    "pci": {
                      "type": "boolean"
                    },
                    "expires": {
                      "type": "string",
                      "format": "date-time"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "proxyConfiguration": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "iqProV2": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "tokenizationId": {
                      "type": "string",
                      "nullable": true
                    },
                    "profiles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "profileName": {
                            "type": "string",
                            "nullable": true
                          },
                          "url": {
                            "type": "string",
                            "nullable": true
                          },
                          "profileKey": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "achConfiguration": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "iqProV2": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "achUrl": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "apiConfiguration": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "iqProV2": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenizationId": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenScheme": {
                      "type": "string",
                      "nullable": true
                    },
                    "authenticationKey": {
                      "type": "string",
                      "nullable": true
                    },
                    "pci": {
                      "type": "boolean"
                    },
                    "expires": {
                      "type": "string",
                      "format": "date-time"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "mobileConfiguration": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "iqProV2": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenizationId": {
                      "type": "string",
                      "nullable": true
                    },
                    "tokenScheme": {
                      "type": "string",
                      "nullable": true
                    },
                    "authenticationKey": {
                      "type": "string",
                      "nullable": true
                    },
                    "pci": {
                      "type": "boolean"
                    },
                    "expires": {
                      "type": "string",
                      "format": "date-time"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cardTokenizer string¦null false none none
achTokenizer string¦null false none none
iframeConfiguration ReadIframeConfiguration¦null false none none
proxyConfiguration ReadProxyConfiguration¦null false none none
achConfiguration ReadAchConfiguration¦null false none none
apiConfiguration ReadApiConfiguration¦null false none none
mobileConfiguration ReadMobileConfiguration¦null false none none

ReadTokenizationConfigurationIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "cardTokenizer": {
              "type": "string",
              "nullable": true
            },
            "achTokenizer": {
              "type": "string",
              "nullable": true
            },
            "iframeConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqPro": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "publicKey": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "origin": {
                              "type": "string",
                              "nullable": true
                            },
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "proxyConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "profiles": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "profileName": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "url": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "profileKey": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              },
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "achConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "achUrl": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "apiConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "mobileConfiguration": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "iqProV2": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "timestamp": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenizationId": {
                              "type": "string",
                              "nullable": true
                            },
                            "tokenScheme": {
                              "type": "string",
                              "nullable": true
                            },
                            "authenticationKey": {
                              "type": "string",
                              "nullable": true
                            },
                            "pci": {
                              "type": "boolean"
                            },
                            "expires": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ReadTokenizationConfiguration¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ReceiptEmailRecipeint

{
  "type": "object",
  "properties": {
    "to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
to [string]¦null false none none
name string¦null false none none

ReceiptEmailRequestModel

{
  "required": [
    "from",
    "recipient"
  ],
  "type": "object",
  "properties": {
    "sourceTransactionId": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "recipient": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "to": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "nullable": true
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "from": {
      "minLength": 1,
      "type": "string",
      "format": "email"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
sourceTransactionId string¦null false none none
recipient ReceiptEmailRecipeint true none none
from string(email) true none none

ResponseGatewayUserDetail

{
  "type": "object",
  "properties": {
    "gatewayUserId": {
      "type": "string",
      "format": "uuid"
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "gatewayUserStatus": {
      "enum": [
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "user": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "type": "string",
              "nullable": true
            },
            "lastName": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "userPermissions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "permissionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "order": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "userRole": {
              "enum": [
                "SU",
                "SA",
                "GA",
                "GS"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "role": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "roleId": {
              "type": "string",
              "format": "uuid"
            },
            "code": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "isGatewayRole": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "gatewayUserPermissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "order": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayUserId string(uuid) false none none
phone string¦null false none none
gatewayUserStatus string false none none
user UserDetailResponse¦null false none none
role RoleDetailsResponse¦null false none none
gatewayUserPermissions [UserPermission]¦null false none none

Enumerated Values

Property Value
gatewayUserStatus Active
gatewayUserStatus Disabled

ResponseGatewayUserDetailIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "gatewayUserStatus": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "user": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "userId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "email": {
                      "type": "string",
                      "nullable": true
                    },
                    "firstName": {
                      "type": "string",
                      "nullable": true
                    },
                    "lastName": {
                      "type": "string",
                      "nullable": true
                    },
                    "status": {
                      "type": "string",
                      "nullable": true
                    },
                    "createdDateTime": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "userPermissions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "permissionId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "code": {
                            "type": "string",
                            "nullable": true
                          },
                          "description": {
                            "type": "string",
                            "nullable": true
                          },
                          "order": {
                            "type": "integer",
                            "format": "int32"
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    },
                    "userRole": {
                      "enum": [
                        "SU",
                        "SA",
                        "GA",
                        "GS"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "role": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "roleId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "code": {
                      "type": "string",
                      "nullable": true
                    },
                    "description": {
                      "type": "string",
                      "nullable": true
                    },
                    "isGatewayRole": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "gatewayUserPermissions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "permissionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "order": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseGatewayUserDetail¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseGatewayUserDetailWithGateway

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "format": "uuid"
    },
    "userStatus": {
      "enum": [
        "InvitePending",
        "PendingTOS",
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "gateways": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gatewayUserId": {
            "type": "string",
            "format": "uuid"
          },
          "gateway": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "status": {
                    "enum": [
                      "Active",
                      "Disabled"
                    ],
                    "type": "string"
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "phoneExternal": {
                    "type": "string",
                    "nullable": true
                  },
                  "receiptEmail": {
                    "type": "string",
                    "nullable": true
                  },
                  "website": {
                    "type": "string",
                    "nullable": true
                  },
                  "timezone": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
userId string(uuid) false none none
userStatus string false none none
gateways [GatewayUserGatewayDetailsModel]¦null false none none

Enumerated Values

Property Value
userStatus InvitePending
userStatus PendingTOS
userStatus Active
userStatus Disabled

ResponseGatewayUserDetailWithGatewayIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            },
            "userStatus": {
              "enum": [
                "InvitePending",
                "PendingTOS",
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "gateways": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gateway": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "gatewayId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          },
                          "status": {
                            "enum": [
                              "Active",
                              "Disabled"
                            ],
                            "type": "string"
                          },
                          "phone": {
                            "type": "string",
                            "nullable": true
                          },
                          "phoneExternal": {
                            "type": "string",
                            "nullable": true
                          },
                          "receiptEmail": {
                            "type": "string",
                            "nullable": true
                          },
                          "website": {
                            "type": "string",
                            "nullable": true
                          },
                          "timezone": {
                            "type": "string",
                            "nullable": true
                          },
                          "createdDateTime": {
                            "type": "string",
                            "format": "date-time"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseGatewayUserDetailWithGateway¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseInsertInvoice

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceId string(uuid) false none none

ResponseInsertInvoiceIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseInsertInvoice¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseInsertProduct

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
productId string(uuid) false none none

ResponseInsertProductIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "productId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseInsertProduct¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseInsertTransactionCustomer

{
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "format": "uuid"
    },
    "customerId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionId string(uuid) false none none
customerId string(uuid) false none none

ResponseInsertTransactionCustomerIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "customerId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseInsertTransactionCustomer¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseInvoiceFees

{
  "type": "object",
  "properties": {
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "discounts": {
      "type": "number",
      "format": "double"
    },
    "tax": {
      "type": "number",
      "format": "double"
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "shipping": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "amount": {
              "type": "number",
              "format": "double"
            },
            "taxPlacement": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
subtotal number(double) false none none
discounts number(double) false none none
tax number(double) false none none
total number(double) false none none
shipping ShippingResponse¦null false none none

ResponseInvoiceFeesIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "discounts": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "taxPlacement": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseInvoiceFees¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseMetadata

{
  "type": "object",
  "properties": {
    "metadataId": {
      "type": "integer",
      "format": "int32"
    },
    "preferenceName": {
      "type": "string",
      "nullable": true
    },
    "metadataName": {
      "type": "string",
      "nullable": true
    },
    "metadataValue": {
      "type": "string",
      "nullable": true
    },
    "metadataDisplayName": {
      "type": "string",
      "nullable": true
    },
    "metadataDescription": {
      "type": "string",
      "nullable": true
    },
    "metadataDataType": {
      "type": "string",
      "nullable": true
    },
    "isPublic": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
metadataId integer(int32) false none none
preferenceName string¦null false none none
metadataName string¦null false none none
metadataValue string¦null false none none
metadataDisplayName string¦null false none none
metadataDescription string¦null false none none
metadataDataType string¦null false none none
isPublic boolean false none none

ResponseMetadata2

{
  "type": "object",
  "properties": {
    "metadataId": {
      "type": "integer",
      "format": "int32"
    },
    "preferenceName": {
      "type": "string",
      "nullable": true
    },
    "metadataName": {
      "type": "string",
      "nullable": true
    },
    "metadataDisplayName": {
      "type": "string",
      "nullable": true
    },
    "metadataDescription": {
      "type": "string",
      "nullable": true
    },
    "metadataValue": {
      "type": "string",
      "nullable": true
    },
    "metadataDataType": {
      "type": "string",
      "nullable": true
    },
    "isPublic": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
metadataId integer(int32) false none none
preferenceName string¦null false none none
metadataName string¦null false none none
metadataDisplayName string¦null false none none
metadataDescription string¦null false none none
metadataValue string¦null false none none
metadataDataType string¦null false none none
isPublic boolean false none none

ResponsePatchCustomFieldCategory

{
  "type": "object",
  "properties": {
    "customFieldCategoryId": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customFieldCategoryId integer(int32) false none none

ResponsePatchCustomFieldCategoryListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [ResponsePatchCustomFieldCategory]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponsePatchProduct

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
productId string(uuid) false none none

ResponsePatchProductListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [ResponsePatchProduct]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseProcessorType

{
  "type": "object",
  "properties": {
    "processorTypeId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "type": {
      "enum": [
        "CreditCard",
        "Ach"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
processorTypeId string(uuid) false none none
name string¦null false none none
createdDateTime string(date-time) false none none
type string false none none

Enumerated Values

Property Value
type CreditCard
type Ach

ResponseReadGateway

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "enum": [
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "merchantId": {
      "type": "string",
      "nullable": true
    },
    "sourceReferenceId": {
      "type": "string",
      "nullable": true
    },
    "contactCompany": {
      "type": "string",
      "nullable": true
    },
    "contactName": {
      "type": "string",
      "nullable": true
    },
    "contactEmail": {
      "type": "string",
      "nullable": true
    },
    "feeScheduleId": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "phoneExternal": {
      "type": "string",
      "nullable": true
    },
    "receiptEmail": {
      "type": "string",
      "nullable": true
    },
    "website": {
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "type": "string",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gatewayAddressId": {
            "type": "string",
            "format": "uuid"
          },
          "gatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "addressId": {
            "type": "string",
            "format": "uuid"
          },
          "isPrimary": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isInvoice": {
            "type": "boolean"
          },
          "addressModel": {
            "allOf": [
              {
                "required": [
                  "addressLine1",
                  "firstName"
                ],
                "type": "object",
                "properties": {
                  "addressLine1": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "addressLine2": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "maxLength": 3,
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "maxLength": 16,
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "firstName": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "lastName": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "maxLength": 100,
                    "type": "string",
                    "format": "email",
                    "nullable": true
                  },
                  "phone": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "processors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "processorId": {
            "type": "string",
            "format": "uuid"
          },
          "processorType": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "processorTypeId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "enum": [
                      "CreditCard",
                      "Ach"
                    ],
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "merchantId": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "hour": {
            "type": "integer",
            "format": "int32"
          },
          "minute": {
            "type": "integer",
            "format": "int32"
          },
          "paymentAdjustmentTypeId": {
            "enum": [
              "NoAdj",
              "Flat",
              "Percentage"
            ],
            "type": "string"
          },
          "paymentAdjustmentType": {
            "type": "string",
            "nullable": true
          },
          "paymentAdjustmentLabel": {
            "enum": [
              "NoLabel",
              "ConvenienceFee",
              "ServiceFee",
              "AdminFee",
              "ShippingHandlingFee"
            ],
            "type": "string"
          },
          "paymentAdjustmentValue": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "preferences": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "metadataId": {
                  "type": "integer",
                  "format": "int32"
                },
                "preferenceName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataValue": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDisplayName": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDescription": {
                  "type": "string",
                  "nullable": true
                },
                "metadataDataType": {
                  "type": "string",
                  "nullable": true
                },
                "isPublic": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "settings": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "rapidOtc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "rapidHc": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "merchantId": {
                            "type": "string",
                            "nullable": true
                          },
                          "groupId": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalId": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          },
                          "did": {
                            "type": "string",
                            "nullable": true
                          },
                          "visaMcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcMcc": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "tsysSierra": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "bin": {
                            "type": "string",
                            "nullable": true
                          },
                          "mid": {
                            "type": "string",
                            "nullable": true
                          },
                          "mvv": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentBankNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "agentChainNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "storeNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "terminalNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "industryCode": {
                            "enum": [
                              "Unknown",
                              "A",
                              "B",
                              "D",
                              "F",
                              "G",
                              "H",
                              "L",
                              "O",
                              "P",
                              "R"
                            ],
                            "type": "string"
                          },
                          "currencyCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "countryCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "cityCode": {
                            "type": "string",
                            "nullable": true
                          },
                          "languageIndicator": {
                            "type": "string",
                            "nullable": true
                          },
                          "timeZone": {
                            "type": "string",
                            "nullable": true
                          },
                          "mcc": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantName": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocation": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantState": {
                            "type": "string",
                            "nullable": true
                          },
                          "merchantLocationNumber": {
                            "type": "string",
                            "nullable": true
                          },
                          "classification": {
                            "enum": [
                              "Ecomm",
                              "MOTO",
                              "Retail"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "sageAch": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "terminals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "terminalId": {
                                  "type": "string",
                                  "nullable": true
                                },
                                "secCode": {
                                  "enum": [
                                    "PPD",
                                    "CCD",
                                    "WEB",
                                    "TEL"
                                  ],
                                  "type": "string"
                                },
                                "type": {
                                  "enum": [
                                    "OneTime",
                                    "Recurring"
                                  ],
                                  "type": "string"
                                },
                                "dlRequired": {
                                  "type": "boolean"
                                },
                                "idRequired": {
                                  "type": "boolean"
                                },
                                "checkVerification": {
                                  "type": "boolean"
                                },
                                "isGatewayTerminal": {
                                  "type": "boolean"
                                },
                                "allowCredits": {
                                  "type": "boolean"
                                },
                                "checkLimit": {
                                  "type": "integer",
                                  "format": "int32"
                                }
                              },
                              "additionalProperties": false
                            },
                            "nullable": true
                          },
                          "hasLevel2Verification": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "features": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "hideInVirtualTerminal": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "disableAutoSettle": {
                    "type": "boolean",
                    "nullable": true
                  },
                  "availableSecCodes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "supportedPaymentMethods": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "supportedCurrencies": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "isDefaultCard": {
            "type": "boolean"
          },
          "isDefaultAch": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "gatewaySettings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "displayName": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "preference": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "metadataId": {
            "type": "integer",
            "format": "int32"
          },
          "preferenceName": {
            "type": "string",
            "nullable": true
          },
          "metadataName": {
            "type": "string",
            "nullable": true
          },
          "metadataDisplayName": {
            "type": "string",
            "nullable": true
          },
          "metadataDescription": {
            "type": "string",
            "nullable": true
          },
          "metadataValue": {
            "type": "string",
            "nullable": true
          },
          "metadataDataType": {
            "type": "string",
            "nullable": true
          },
          "isPublic": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none
status string false none none
name string¦null false none none
merchantId string¦null false none none
sourceReferenceId string¦null false none none
contactCompany string¦null false none none
contactName string¦null false none none
contactEmail string¦null false none none
feeScheduleId string¦null false none none
phone string¦null false none none
phoneExternal string¦null false none none
receiptEmail string¦null false none none
website string¦null false none none
timezone string¦null false none none
createdDateTime string(date-time) false none none
addresses [AddressDetailsModel2]¦null false none none
processors [GetProcessorDetailsModel]¦null false none none
gatewaySettings [ResponseReadGatewaySettings]¦null false none none
preference [ResponseMetadata2]¦null false none none

Enumerated Values

Property Value
status Active
status Disabled

ResponseReadGatewayIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "status": {
              "enum": [
                "Active",
                "Disabled"
              ],
              "type": "string"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "merchantId": {
              "type": "string",
              "nullable": true
            },
            "sourceReferenceId": {
              "type": "string",
              "nullable": true
            },
            "contactCompany": {
              "type": "string",
              "nullable": true
            },
            "contactName": {
              "type": "string",
              "nullable": true
            },
            "contactEmail": {
              "type": "string",
              "nullable": true
            },
            "feeScheduleId": {
              "type": "string",
              "nullable": true
            },
            "phone": {
              "type": "string",
              "nullable": true
            },
            "phoneExternal": {
              "type": "string",
              "nullable": true
            },
            "receiptEmail": {
              "type": "string",
              "nullable": true
            },
            "website": {
              "type": "string",
              "nullable": true
            },
            "timezone": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "addresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "gatewayAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isPrimary": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isInvoice": {
                    "type": "boolean"
                  },
                  "addressModel": {
                    "allOf": [
                      {
                        "required": [
                          "addressLine1",
                          "firstName"
                        ],
                        "type": "object",
                        "properties": {
                          "addressLine1": {
                            "maxLength": 50,
                            "minLength": 1,
                            "type": "string"
                          },
                          "addressLine2": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          },
                          "city": {
                            "maxLength": 40,
                            "type": "string",
                            "nullable": true
                          },
                          "state": {
                            "maxLength": 3,
                            "type": "string",
                            "nullable": true
                          },
                          "postalCode": {
                            "maxLength": 16,
                            "type": "string",
                            "nullable": true
                          },
                          "country": {
                            "maxLength": 40,
                            "type": "string",
                            "nullable": true
                          },
                          "firstName": {
                            "maxLength": 50,
                            "minLength": 1,
                            "type": "string"
                          },
                          "lastName": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          },
                          "email": {
                            "maxLength": 100,
                            "type": "string",
                            "format": "email",
                            "nullable": true
                          },
                          "phone": {
                            "maxLength": 10,
                            "pattern": "^(\\d{10})$",
                            "type": "string",
                            "nullable": true
                          },
                          "fax": {
                            "maxLength": 10,
                            "pattern": "^(\\d{10})$",
                            "type": "string",
                            "nullable": true
                          },
                          "company": {
                            "maxLength": 50,
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "processors": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "processorId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "processorTypeId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          },
                          "createdDateTime": {
                            "type": "string",
                            "format": "date-time"
                          },
                          "type": {
                            "enum": [
                              "CreditCard",
                              "Ach"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "merchantId": {
                    "type": "string",
                    "nullable": true
                  },
                  "timezone": {
                    "type": "string",
                    "nullable": true
                  },
                  "hour": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "minute": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "paymentAdjustmentTypeId": {
                    "enum": [
                      "NoAdj",
                      "Flat",
                      "Percentage"
                    ],
                    "type": "string"
                  },
                  "paymentAdjustmentType": {
                    "type": "string",
                    "nullable": true
                  },
                  "paymentAdjustmentLabel": {
                    "enum": [
                      "NoLabel",
                      "ConvenienceFee",
                      "ServiceFee",
                      "AdminFee",
                      "ShippingHandlingFee"
                    ],
                    "type": "string"
                  },
                  "paymentAdjustmentValue": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "preferences": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "metadataId": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "preferenceName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataValue": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDisplayName": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDescription": {
                          "type": "string",
                          "nullable": true
                        },
                        "metadataDataType": {
                          "type": "string",
                          "nullable": true
                        },
                        "isPublic": {
                          "type": "boolean"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "settings": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "rapidOtc": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "merchantId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "groupId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  },
                                  "did": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "visaMcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcMcc": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "rapidHc": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "merchantId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "groupId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalId": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  },
                                  "did": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "visaMcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcMcc": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "tsysSierra": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "bin": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mid": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mvv": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "agentBankNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "agentChainNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "storeNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "terminalNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "industryCode": {
                                    "enum": [
                                      "Unknown",
                                      "A",
                                      "B",
                                      "D",
                                      "F",
                                      "G",
                                      "H",
                                      "L",
                                      "O",
                                      "P",
                                      "R"
                                    ],
                                    "type": "string"
                                  },
                                  "currencyCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "countryCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cityCode": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "languageIndicator": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "timeZone": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "mcc": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantName": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantLocation": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantState": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "merchantLocationNumber": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "classification": {
                                    "enum": [
                                      "Ecomm",
                                      "MOTO",
                                      "Retail"
                                    ],
                                    "type": "string"
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "sageAch": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "terminals": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "terminalId": {
                                          "type": "string",
                                          "nullable": true
                                        },
                                        "secCode": {
                                          "enum": [
                                            "PPD",
                                            "CCD",
                                            "WEB",
                                            "TEL"
                                          ],
                                          "type": "string"
                                        },
                                        "type": {
                                          "enum": [
                                            "OneTime",
                                            "Recurring"
                                          ],
                                          "type": "string"
                                        },
                                        "dlRequired": {
                                          "type": "boolean"
                                        },
                                        "idRequired": {
                                          "type": "boolean"
                                        },
                                        "checkVerification": {
                                          "type": "boolean"
                                        },
                                        "isGatewayTerminal": {
                                          "type": "boolean"
                                        },
                                        "allowCredits": {
                                          "type": "boolean"
                                        },
                                        "checkLimit": {
                                          "type": "integer",
                                          "format": "int32"
                                        }
                                      },
                                      "additionalProperties": false
                                    },
                                    "nullable": true
                                  },
                                  "hasLevel2Verification": {
                                    "type": "boolean"
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "features": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "hideInVirtualTerminal": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "disableAutoSettle": {
                            "type": "boolean",
                            "nullable": true
                          },
                          "availableSecCodes": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "supportedPaymentMethods": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "supportedCurrencies": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "isDefaultCard": {
                    "type": "boolean"
                  },
                  "isDefaultAch": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "gatewaySettings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "preference": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "metadataId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "preferenceName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDisplayName": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDescription": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataValue": {
                    "type": "string",
                    "nullable": true
                  },
                  "metadataDataType": {
                    "type": "string",
                    "nullable": true
                  },
                  "isPublic": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseReadGateway¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseReadGatewaySettings

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
code string¦null false none none
displayName string¦null false none none
description string¦null false none none
value string¦null false none none

ResponseReadInvoice

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "format": "uuid"
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "number": {
      "type": "string",
      "nullable": true
    },
    "invoiceStatus": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceStatusId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoiceType": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceTypeId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountCaptured": {
      "type": "number",
      "format": "double"
    },
    "remainingBalance": {
      "type": "number",
      "format": "double"
    },
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "shipping": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "tax": {
      "type": "number",
      "format": "double"
    },
    "fees": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "discounts": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "requireShippingInfo": {
      "type": "boolean"
    },
    "requireBillingInfo": {
      "type": "boolean"
    },
    "invoiceDate": {
      "type": "string",
      "nullable": true
    },
    "dueDate": {
      "type": "string",
      "nullable": true
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "createdByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "createdDateTime": {
      "type": "string",
      "nullable": true
    },
    "modifiedByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "modifiedDateTime": {
      "type": "string",
      "nullable": true
    },
    "revisionNumber": {
      "type": "integer",
      "format": "int32"
    },
    "gateway": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customer": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoicePaymentMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoicePaymentMethodId": {
              "type": "string",
              "format": "uuid"
            },
            "cardProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "achProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "secCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "card": {
              "type": "boolean"
            },
            "ach": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lineItemId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "integer",
            "format": "int32"
          },
          "unitPrice": {
            "type": "number",
            "format": "double"
          },
          "discount": {
            "type": "number",
            "format": "double"
          },
          "shippedAmount": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "freightAmount": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "unitOfMeasure": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "unitOfMeasureId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "isTaxable": {
            "type": "boolean"
          },
          "localTaxPercent": {
            "type": "number",
            "format": "double"
          },
          "nationalTaxPercent": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "invoiceAddresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoiceAddressId": {
            "type": "string",
            "format": "uuid"
          },
          "addressId": {
            "type": "string",
            "format": "uuid"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isRemittance": {
            "type": "boolean"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "fax": {
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "invoiceNotifications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoiceNotificationGroupId": {
            "type": "string",
            "format": "uuid"
          },
          "notificationMethod": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "invoiceNotificationMethodId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "notificationStatus": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "invoiceNotificationStatusId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "notificationEventType": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "invoiceNotificationEventTypeId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "mainRecipient": {
            "type": "string",
            "nullable": true
          },
          "cc": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "bcc": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "deliveryDateTime": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "customFieldEntries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "modifiedByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "modifiedDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryName": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          },
          "dataType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "format": "uuid"
          },
          "transactionType": {
            "enum": [
              "Sale",
              "Authorize",
              "Capture",
              "Credit",
              "Refund",
              "Verification"
            ],
            "type": "string"
          },
          "paymentType": {
            "enum": [
              "Card",
              "Ach",
              "Token",
              "Terminal"
            ],
            "type": "string"
          },
          "status": {
            "enum": [
              "Unknown",
              "Declined",
              "Authorized",
              "PendingSettlement",
              "Settled",
              "Voided",
              "Refunded",
              "Returned",
              "LateReturn",
              "Pending",
              "PartiallyRefunded"
            ],
            "type": "string"
          },
          "remit": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "settledAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "capturedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "baseAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "authorizedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "taxAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "surchargeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentType": {
                    "enum": [
                      "NoAdj",
                      "Flat",
                      "Percentage"
                    ],
                    "type": "string"
                  },
                  "ach": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "maskedAccount": {
                            "type": "string",
                            "nullable": true
                          },
                          "accountType": {
                            "enum": [
                              "Checking",
                              "Savings"
                            ],
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "card": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "maskedCard": {
                            "type": "string",
                            "nullable": true
                          },
                          "cardType": {
                            "enum": [
                              "Visa",
                              "MasterCard",
                              "Discover",
                              "AmericanExpress"
                            ],
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "settledDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceId string(uuid) false none none
title string¦null false none none
number string¦null false none none
invoiceStatus ResponseReadInvoiceStatus¦null false none none
invoiceType ResponseReadInvoiceType¦null false none none
amountCaptured number(double) false none none
remainingBalance number(double) false none none
subtotal number(double) false none none
shipping number(double)¦null false none none
total number(double) false none none
tax number(double) false none none
fees number(double)¦null false none none
discounts number(double)¦null false none none
requireShippingInfo boolean false none none
requireBillingInfo boolean false none none
invoiceDate string¦null false none none
dueDate string¦null false none none
message string¦null false none none
createdByUserId string(uuid) false none none
createdDateTime string¦null false none none
modifiedByUserId string(uuid) false none none
modifiedDateTime string¦null false none none
revisionNumber integer(int32) false none none
gateway ResponseReadInvoiceGateway¦null false none none
customer ResponseReadInvoiceCustomer¦null false none none
invoicePaymentMethod ResponseReadInvoicePaymentMethod¦null false none none
lineItems [ResponseReadLineItem]¦null false none none
invoiceAddresses [ResponseReadInvoiceAddress]¦null false none none
invoiceNotifications [ResponseReadInvoiceNotificationGroup]¦null false none none
customFieldEntries [CustomFieldEntryModel]¦null false none none
transactions [ResponseReadInvoiceTransaction]¦null false none none

ResponseReadInvoiceAddress

{
  "type": "object",
  "properties": {
    "invoiceAddressId": {
      "type": "string",
      "format": "uuid"
    },
    "addressId": {
      "type": "string",
      "format": "uuid"
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "isRemittance": {
      "type": "boolean"
    },
    "firstName": {
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "type": "string",
      "nullable": true
    },
    "company": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "fax": {
      "type": "string",
      "nullable": true
    },
    "addressLine1": {
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "type": "string",
      "nullable": true
    },
    "city": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceAddressId string(uuid) false none none
addressId string(uuid) false none none
isShipping boolean false none none
isBilling boolean false none none
isRemittance boolean false none none
firstName string¦null false none none
lastName string¦null false none none
company string¦null false none none
email string¦null false none none
phone string¦null false none none
fax string¦null false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none

ResponseReadInvoiceByToken

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "format": "uuid"
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "number": {
      "type": "string",
      "nullable": true
    },
    "invoiceStatus": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceStatusId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "remainingBalance": {
      "type": "number",
      "format": "double"
    },
    "capturedAmount": {
      "type": "number",
      "format": "double"
    },
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "shipping": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "tax": {
      "type": "number",
      "format": "double"
    },
    "fees": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "discounts": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "requireShippingInfo": {
      "type": "boolean"
    },
    "requireBillingInfo": {
      "type": "boolean"
    },
    "invoiceDate": {
      "type": "string",
      "nullable": true
    },
    "dueDate": {
      "type": "string",
      "nullable": true
    },
    "message": {
      "type": "string",
      "nullable": true
    },
    "surcharge": {
      "type": "boolean"
    },
    "surchargePercentage": {
      "type": "number",
      "format": "double"
    },
    "gateway": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customer": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoicePaymentMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoicePaymentMethodId": {
              "type": "string",
              "format": "uuid"
            },
            "cardProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "achProcessorId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "secCode": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            },
            "card": {
              "type": "boolean"
            },
            "ach": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "format": "uuid"
          },
          "transactionType": {
            "enum": [
              "Sale",
              "Authorize",
              "Capture",
              "Credit",
              "Refund",
              "Verification"
            ],
            "type": "string"
          },
          "paymentType": {
            "enum": [
              "Card",
              "Ach",
              "Token",
              "Terminal"
            ],
            "type": "string"
          },
          "status": {
            "enum": [
              "Unknown",
              "Declined",
              "Authorized",
              "PendingSettlement",
              "Settled",
              "Voided",
              "Refunded",
              "Returned",
              "LateReturn",
              "Pending",
              "PartiallyRefunded"
            ],
            "type": "string"
          },
          "remit": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "settledAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "capturedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "baseAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "authorizedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "taxAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "surchargeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentType": {
                    "enum": [
                      "NoAdj",
                      "Flat",
                      "Percentage"
                    ],
                    "type": "string"
                  },
                  "ach": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "maskedAccount": {
                            "type": "string",
                            "nullable": true
                          },
                          "accountType": {
                            "enum": [
                              "Checking",
                              "Savings"
                            ],
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "card": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "maskedCard": {
                            "type": "string",
                            "nullable": true
                          },
                          "cardType": {
                            "enum": [
                              "Visa",
                              "MasterCard",
                              "Discover",
                              "AmericanExpress"
                            ],
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "settledDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lineItemId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "integer",
            "format": "int32"
          },
          "unitPrice": {
            "type": "number",
            "format": "double"
          },
          "discount": {
            "type": "number",
            "format": "double"
          },
          "shippedAmount": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "freightAmount": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "unitOfMeasure": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "unitOfMeasureId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "isTaxable": {
            "type": "boolean"
          },
          "localTaxPercent": {
            "type": "number",
            "format": "double"
          },
          "nationalTaxPercent": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "invoiceAddresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoiceAddressId": {
            "type": "string",
            "format": "uuid"
          },
          "addressId": {
            "type": "string",
            "format": "uuid"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isRemittance": {
            "type": "boolean"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "fax": {
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceId string(uuid) false none none
title string¦null false none none
number string¦null false none none
invoiceStatus ResponseReadInvoiceStatus¦null false none none
remainingBalance number(double) false none none
capturedAmount number(double) false none none
subtotal number(double) false none none
shipping number(double)¦null false none none
total number(double) false none none
tax number(double) false none none
fees number(double)¦null false none none
discounts number(double)¦null false none none
requireShippingInfo boolean false none none
requireBillingInfo boolean false none none
invoiceDate string¦null false none none
dueDate string¦null false none none
message string¦null false none none
surcharge boolean false none none
surchargePercentage number(double) false none none
gateway ResponseReadInvoiceGateway¦null false none none
customer ResponseReadInvoiceCustomer¦null false none none
invoicePaymentMethod ResponseReadInvoicePaymentMethod¦null false none none
transactions [ResponseReadInvoiceTransaction]¦null false none none
lineItems [ResponseReadLineItem]¦null false none none
invoiceAddresses [ResponseReadInvoiceAddress]¦null false none none

ResponseReadInvoiceByTokenIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            },
            "title": {
              "type": "string",
              "nullable": true
            },
            "number": {
              "type": "string",
              "nullable": true
            },
            "invoiceStatus": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceStatusId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "remainingBalance": {
              "type": "number",
              "format": "double"
            },
            "capturedAmount": {
              "type": "number",
              "format": "double"
            },
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "fees": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "discounts": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "requireShippingInfo": {
              "type": "boolean"
            },
            "requireBillingInfo": {
              "type": "boolean"
            },
            "invoiceDate": {
              "type": "string",
              "nullable": true
            },
            "dueDate": {
              "type": "string",
              "nullable": true
            },
            "message": {
              "type": "string",
              "nullable": true
            },
            "surcharge": {
              "type": "boolean"
            },
            "surchargePercentage": {
              "type": "number",
              "format": "double"
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoicePaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoicePaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "cardProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "achProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "secCode": {
                      "type": "integer",
                      "format": "int32",
                      "nullable": true
                    },
                    "card": {
                      "type": "boolean"
                    },
                    "ach": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "transactionType": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentType": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "remit": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "settledAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "capturedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "baseAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "authorizedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "taxAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "surchargeAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentType": {
                            "enum": [
                              "NoAdj",
                              "Flat",
                              "Percentage"
                            ],
                            "type": "string"
                          },
                          "ach": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedAccount": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "accountType": {
                                    "enum": [
                                      "Checking",
                                      "Savings"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "card": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedCard": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cardType": {
                                    "enum": [
                                      "Visa",
                                      "MasterCard",
                                      "Discover",
                                      "AmericanExpress"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "settledDateTime": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "lineItemId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "quantity": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "discount": {
                    "type": "number",
                    "format": "double"
                  },
                  "shippedAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "freightAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isTaxable": {
                    "type": "boolean"
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double"
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isRemittance": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseReadInvoiceByToken¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseReadInvoiceCustomer

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid) false none none
name string¦null false none none

ResponseReadInvoiceGateway

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none
name string¦null false none none

ResponseReadInvoiceIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceId": {
              "type": "string",
              "format": "uuid"
            },
            "title": {
              "type": "string",
              "nullable": true
            },
            "number": {
              "type": "string",
              "nullable": true
            },
            "invoiceStatus": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceStatusId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoiceType": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoiceTypeId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "amountCaptured": {
              "type": "number",
              "format": "double"
            },
            "remainingBalance": {
              "type": "number",
              "format": "double"
            },
            "subtotal": {
              "type": "number",
              "format": "double"
            },
            "shipping": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "total": {
              "type": "number",
              "format": "double"
            },
            "tax": {
              "type": "number",
              "format": "double"
            },
            "fees": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "discounts": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "requireShippingInfo": {
              "type": "boolean"
            },
            "requireBillingInfo": {
              "type": "boolean"
            },
            "invoiceDate": {
              "type": "string",
              "nullable": true
            },
            "dueDate": {
              "type": "string",
              "nullable": true
            },
            "message": {
              "type": "string",
              "nullable": true
            },
            "createdByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "createdDateTime": {
              "type": "string",
              "nullable": true
            },
            "modifiedByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "modifiedDateTime": {
              "type": "string",
              "nullable": true
            },
            "revisionNumber": {
              "type": "integer",
              "format": "int32"
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "invoicePaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "invoicePaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "cardProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "achProcessorId": {
                      "type": "string",
                      "format": "uuid",
                      "nullable": true
                    },
                    "secCode": {
                      "type": "integer",
                      "format": "int32",
                      "nullable": true
                    },
                    "card": {
                      "type": "boolean"
                    },
                    "ach": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "lineItems": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "lineItemId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "quantity": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "discount": {
                    "type": "number",
                    "format": "double"
                  },
                  "shippedAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "freightAmount": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "isTaxable": {
                    "type": "boolean"
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double"
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "addressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "isRemittance": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "invoiceNotifications": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceNotificationGroupId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "notificationMethod": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationMethodId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "notificationStatus": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationStatusId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "notificationEventType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceNotificationEventTypeId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "mainRecipient": {
                    "type": "string",
                    "nullable": true
                  },
                  "cc": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "bcc": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "nullable": true
                  },
                  "deliveryDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "transactions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "transactionType": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentType": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "remit": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "settledAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "capturedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "baseAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "authorizedAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "taxAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "surchargeAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentAmount": {
                            "type": "number",
                            "format": "double"
                          },
                          "paymentAdjustmentType": {
                            "enum": [
                              "NoAdj",
                              "Flat",
                              "Percentage"
                            ],
                            "type": "string"
                          },
                          "ach": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedAccount": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "accountType": {
                                    "enum": [
                                      "Checking",
                                      "Savings"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "card": {
                            "allOf": [
                              {
                                "type": "object",
                                "properties": {
                                  "maskedCard": {
                                    "type": "string",
                                    "nullable": true
                                  },
                                  "cardType": {
                                    "enum": [
                                      "Visa",
                                      "MasterCard",
                                      "Discover",
                                      "AmericanExpress"
                                    ],
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "additionalProperties": false
                              }
                            ],
                            "nullable": true
                          },
                          "settledDateTime": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseReadInvoice¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseReadInvoiceNotificationEventType

{
  "type": "object",
  "properties": {
    "invoiceNotificationEventTypeId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceNotificationEventTypeId integer(int32) false none none
name string¦null false none none

ResponseReadInvoiceNotificationGroup

{
  "type": "object",
  "properties": {
    "invoiceNotificationGroupId": {
      "type": "string",
      "format": "uuid"
    },
    "notificationMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceNotificationMethodId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "notificationStatus": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceNotificationStatusId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "notificationEventType": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceNotificationEventTypeId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "mainRecipient": {
      "type": "string",
      "nullable": true
    },
    "cc": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "bcc": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "deliveryDateTime": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceNotificationGroupId string(uuid) false none none
notificationMethod ResponseReadInvoiceNotificationMethod¦null false none none
notificationStatus ResponseReadInvoiceNotificationStatus¦null false none none
notificationEventType ResponseReadInvoiceNotificationEventType¦null false none none
mainRecipient string¦null false none none
cc [string]¦null false none none
bcc [string]¦null false none none
deliveryDateTime string¦null false none none

ResponseReadInvoiceNotificationMethod

{
  "type": "object",
  "properties": {
    "invoiceNotificationMethodId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceNotificationMethodId integer(int32) false none none
name string¦null false none none

ResponseReadInvoiceNotificationStatus

{
  "type": "object",
  "properties": {
    "invoiceNotificationStatusId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceNotificationStatusId integer(int32) false none none
name string¦null false none none

ResponseReadInvoicePaymentMethod

{
  "type": "object",
  "properties": {
    "invoicePaymentMethodId": {
      "type": "string",
      "format": "uuid"
    },
    "cardProcessorId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "achProcessorId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "secCode": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "card": {
      "type": "boolean"
    },
    "ach": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoicePaymentMethodId string(uuid) false none none
cardProcessorId string(uuid)¦null false none none
achProcessorId string(uuid)¦null false none none
secCode integer(int32)¦null false none none
card boolean false none none
ach boolean false none none

ResponseReadInvoiceStatus

{
  "type": "object",
  "properties": {
    "invoiceStatusId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceStatusId integer(int32) false none none
name string¦null false none none

ResponseReadInvoiceTokenACH

{
  "type": "object",
  "properties": {
    "maskedAccount": {
      "type": "string",
      "nullable": true
    },
    "accountType": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedAccount string¦null false none none
accountType string¦null false none none

Enumerated Values

Property Value
accountType Checking
accountType Savings

ResponseReadInvoiceTokenCard

{
  "type": "object",
  "properties": {
    "maskedCard": {
      "type": "string",
      "nullable": true
    },
    "cardType": {
      "enum": [
        "Visa",
        "MasterCard",
        "Discover",
        "AmericanExpress"
      ],
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedCard string¦null false none none
cardType string¦null false none none

Enumerated Values

Property Value
cardType Visa
cardType MasterCard
cardType Discover
cardType AmericanExpress

ResponseReadInvoiceTokenRemit

{
  "type": "object",
  "properties": {
    "settledAmount": {
      "type": "number",
      "format": "double"
    },
    "capturedAmount": {
      "type": "number",
      "format": "double"
    },
    "baseAmount": {
      "type": "number",
      "format": "double"
    },
    "authorizedAmount": {
      "type": "number",
      "format": "double"
    },
    "taxAmount": {
      "type": "number",
      "format": "double"
    },
    "surchargeAmount": {
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentAmount": {
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string"
    },
    "ach": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedAccount": {
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "card": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedCard": {
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "settledDateTime": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
settledAmount number(double) false none none
capturedAmount number(double) false none none
baseAmount number(double) false none none
authorizedAmount number(double) false none none
taxAmount number(double) false none none
surchargeAmount number(double) false none none
paymentAdjustmentAmount number(double) false none none
paymentAdjustmentType string false none none
ach ResponseReadInvoiceTokenACH¦null false none none
card ResponseReadInvoiceTokenCard¦null false none none
settledDateTime string¦null false none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage

ResponseReadInvoiceTransaction

{
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "format": "uuid"
    },
    "transactionType": {
      "enum": [
        "Sale",
        "Authorize",
        "Capture",
        "Credit",
        "Refund",
        "Verification"
      ],
      "type": "string"
    },
    "paymentType": {
      "enum": [
        "Card",
        "Ach",
        "Token",
        "Terminal"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "Unknown",
        "Declined",
        "Authorized",
        "PendingSettlement",
        "Settled",
        "Voided",
        "Refunded",
        "Returned",
        "LateReturn",
        "Pending",
        "PartiallyRefunded"
      ],
      "type": "string"
    },
    "remit": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "settledAmount": {
              "type": "number",
              "format": "double"
            },
            "capturedAmount": {
              "type": "number",
              "format": "double"
            },
            "baseAmount": {
              "type": "number",
              "format": "double"
            },
            "authorizedAmount": {
              "type": "number",
              "format": "double"
            },
            "taxAmount": {
              "type": "number",
              "format": "double"
            },
            "surchargeAmount": {
              "type": "number",
              "format": "double"
            },
            "paymentAdjustmentAmount": {
              "type": "number",
              "format": "double"
            },
            "paymentAdjustmentType": {
              "enum": [
                "NoAdj",
                "Flat",
                "Percentage"
              ],
              "type": "string"
            },
            "ach": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedAccount": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountType": {
                      "enum": [
                        "Checking",
                        "Savings"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "card": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedCard": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardType": {
                      "enum": [
                        "Visa",
                        "MasterCard",
                        "Discover",
                        "AmericanExpress"
                      ],
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "settledDateTime": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionId string(uuid) false none none
transactionType string false none none
paymentType string false none none
status string false none none
remit ResponseReadInvoiceTokenRemit¦null false none none
createdDateTime string¦null false none none

Enumerated Values

Property Value
transactionType Sale
transactionType Authorize
transactionType Capture
transactionType Credit
transactionType Refund
transactionType Verification
paymentType Card
paymentType Ach
paymentType Token
paymentType Terminal
status Unknown
status Declined
status Authorized
status PendingSettlement
status Settled
status Voided
status Refunded
status Returned
status LateReturn
status Pending
status PartiallyRefunded

ResponseReadInvoiceType

{
  "type": "object",
  "properties": {
    "invoiceTypeId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceTypeId integer(int32) false none none
name string¦null false none none

ResponseReadLineItem

{
  "type": "object",
  "properties": {
    "lineItemId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "quantity": {
      "type": "integer",
      "format": "int32"
    },
    "unitPrice": {
      "type": "number",
      "format": "double"
    },
    "discount": {
      "type": "number",
      "format": "double"
    },
    "shippedAmount": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "freightAmount": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "unitOfMeasure": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "unitOfMeasureId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "isTaxable": {
      "type": "boolean"
    },
    "localTaxPercent": {
      "type": "number",
      "format": "double"
    },
    "nationalTaxPercent": {
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
lineItemId string(uuid) false none none
name string¦null false none none
description string¦null false none none
quantity integer(int32) false none none
unitPrice number(double) false none none
discount number(double) false none none
shippedAmount number(double)¦null false none none
freightAmount number(double)¦null false none none
unitOfMeasure ResponseReadUnitOfMeasure2¦null false none none
isTaxable boolean false none none
localTaxPercent number(double) false none none
nationalTaxPercent number(double) false none none

ResponseReadProduct

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "unitPrice": {
      "type": "number",
      "format": "double"
    },
    "unitOfMeasure": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "unitOfMeasureId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "imageUrl": {
      "type": "string",
      "nullable": true
    },
    "localTaxPercent": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "nationalTaxPercent": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "nullable": true
    },
    "createdByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "modifiedDateTime": {
      "type": "string",
      "nullable": true
    },
    "modifiedByUserId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
productId string(uuid) false none none
name string¦null false none none
description string¦null false none none
unitPrice number(double) false none none
unitOfMeasure ResponseReadUnitOfMeasure¦null false none none
imageUrl string¦null false none none
localTaxPercent number(double)¦null false none none
nationalTaxPercent number(double)¦null false none none
createdDateTime string¦null false none none
createdByUserId string(uuid) false none none
modifiedDateTime string¦null false none none
modifiedByUserId string(uuid) false none none

ResponseReadProductIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "productId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "unitPrice": {
              "type": "number",
              "format": "double"
            },
            "unitOfMeasure": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "unitOfMeasureId": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "imageUrl": {
              "type": "string",
              "nullable": true
            },
            "localTaxPercent": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "nationalTaxPercent": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "nullable": true
            },
            "createdByUserId": {
              "type": "string",
              "format": "uuid"
            },
            "modifiedDateTime": {
              "type": "string",
              "nullable": true
            },
            "modifiedByUserId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseReadProduct¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseReadProductPagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "productId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "unitPrice": {
            "type": "number",
            "format": "double"
          },
          "unitOfMeasure": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "unitOfMeasureId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "imageUrl": {
            "type": "string",
            "nullable": true
          },
          "localTaxPercent": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "nationalTaxPercent": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "nullable": true
          },
          "createdByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "modifiedDateTime": {
            "type": "string",
            "nullable": true
          },
          "modifiedByUserId": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [ResponseReadProduct]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

ResponseReadProductPagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "productId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "unitPrice": {
                    "type": "number",
                    "format": "double"
                  },
                  "unitOfMeasure": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "unitOfMeasureId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "imageUrl": {
                    "type": "string",
                    "nullable": true
                  },
                  "localTaxPercent": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "nationalTaxPercent": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseReadProductPagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseReadSourceProperties

{
  "type": "object",
  "properties": {
    "sourceUserName": {
      "type": "string",
      "nullable": true
    },
    "sourceTransactionId": {
      "type": "string",
      "nullable": true
    },
    "sourceSettlementBatchId": {
      "type": "string",
      "nullable": true
    },
    "sourceOrderId": {
      "type": "string",
      "nullable": true
    },
    "sourceLastActionAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
sourceUserName string¦null false none none
sourceTransactionId string¦null false none none
sourceSettlementBatchId string¦null false none none
sourceOrderId string¦null false none none
sourceLastActionAt string(date-time)¦null false none none

ResponseReadTransactionFeature

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
code string¦null false none none
displayName string¦null false none none

ResponseReadTransactionReadGatewayUser

{
  "type": "object",
  "properties": {
    "gatewayUserId": {
      "type": "string",
      "format": "uuid"
    },
    "firstName": {
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayUserId string(uuid) false none none
firstName string¦null false none none
lastName string¦null false none none

ResponseReadTransactionRemit

{
  "type": "object",
  "properties": {
    "baseAmount": {
      "type": "number",
      "format": "double"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "amountAuthorized": {
      "type": "number",
      "format": "double"
    },
    "amountCaptured": {
      "type": "number",
      "format": "double"
    },
    "amountSettled": {
      "type": "number",
      "format": "double"
    },
    "amountRefunded": {
      "type": "number",
      "format": "double"
    },
    "taxAmount": {
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string",
      "nullable": true
    },
    "paymentAdjustmentValue": {
      "type": "number",
      "format": "double"
    },
    "tip": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "cashBack": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "taxExempt": {
      "type": "boolean"
    },
    "shippingAmount": {
      "type": "number",
      "format": "double"
    },
    "surcharge": {
      "type": "number",
      "format": "double"
    },
    "discountAmount": {
      "type": "number",
      "format": "double"
    },
    "serviceFee": {
      "type": "number",
      "format": "double"
    },
    "nationalTaxAmount": {
      "type": "number",
      "format": "double"
    },
    "dutyAmount": {
      "type": "number",
      "format": "double"
    },
    "currencyCode": {
      "enum": [
        "USD"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
baseAmount number(double) false none none
amount number(double) false none none
amountAuthorized number(double) false none none
amountCaptured number(double) false none none
amountSettled number(double) false none none
amountRefunded number(double) false none none
taxAmount number(double) false none none
paymentAdjustmentType string¦null false none none
paymentAdjustmentValue number(double) false none none
tip number(double)¦null false none none
cashBack number(double)¦null false none none
taxExempt boolean false none none
shippingAmount number(double) false none none
surcharge number(double) false none none
discountAmount number(double) false none none
serviceFee number(double) false none none
nationalTaxAmount number(double) false none none
dutyAmount number(double) false none none
currencyCode string false none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage
currencyCode USD

ResponseReadUnitOfMeasure

{
  "type": "object",
  "properties": {
    "unitOfMeasureId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
unitOfMeasureId integer(int32) false none none
name string¦null false none none

ResponseReadUnitOfMeasure2

{
  "type": "object",
  "properties": {
    "unitOfMeasureId": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
unitOfMeasureId integer(int32) false none none
name string¦null false none none

ResponseReadUnitOfMeasureListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "unitOfMeasureId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [ResponseReadUnitOfMeasure]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseSearchInvoice

{
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string",
      "format": "uuid"
    },
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "number": {
      "type": "string",
      "nullable": true
    },
    "customer": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoiceStatus": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceStatusId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoiceType": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "invoiceTypeId": {
              "type": "integer",
              "format": "int32"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountCaptured": {
      "type": "number",
      "format": "double"
    },
    "remainingBalance": {
      "type": "number",
      "format": "double"
    },
    "subtotal": {
      "type": "number",
      "format": "double"
    },
    "shipping": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "fees": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "discounts": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "tax": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "transactionIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    },
    "invoiceDate": {
      "type": "string",
      "nullable": true
    },
    "dueDate": {
      "type": "string",
      "nullable": true
    },
    "createdByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "createdDateTime": {
      "type": "string",
      "nullable": true
    },
    "modifiedByUserId": {
      "type": "string",
      "format": "uuid"
    },
    "modifiedDateTime": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
invoiceId string(uuid) false none none
gatewayId string(uuid) false none none
title string¦null false none none
number string¦null false none none
customer ResponseReadInvoiceCustomer¦null false none none
invoiceStatus ResponseReadInvoiceStatus¦null false none none
invoiceType ResponseReadInvoiceType¦null false none none
amountCaptured number(double) false none none
remainingBalance number(double) false none none
subtotal number(double) false none none
shipping number(double)¦null false none none
total number(double) false none none
fees number(double)¦null false none none
discounts number(double)¦null false none none
tax number(double)¦null false none none
transactionIds [string]¦null false none none
invoiceDate string¦null false none none
dueDate string¦null false none none
createdByUserId string(uuid) false none none
createdDateTime string¦null false none none
modifiedByUserId string(uuid) false none none
modifiedDateTime string¦null false none none

ResponseSearchInvoicePagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "invoiceId": {
            "type": "string",
            "format": "uuid"
          },
          "gatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "number": {
            "type": "string",
            "nullable": true
          },
          "customer": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "customerId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "invoiceStatus": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "invoiceStatusId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "invoiceType": {
            "allOf": [
              {
                "type": "object",
                "properties": {
                  "invoiceTypeId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          },
          "amountCaptured": {
            "type": "number",
            "format": "double"
          },
          "remainingBalance": {
            "type": "number",
            "format": "double"
          },
          "subtotal": {
            "type": "number",
            "format": "double"
          },
          "shipping": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "total": {
            "type": "number",
            "format": "double"
          },
          "fees": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "discounts": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "tax": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "transactionIds": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "nullable": true
          },
          "invoiceDate": {
            "type": "string",
            "nullable": true
          },
          "dueDate": {
            "type": "string",
            "nullable": true
          },
          "createdByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "createdDateTime": {
            "type": "string",
            "nullable": true
          },
          "modifiedByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "modifiedDateTime": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [ResponseSearchInvoice]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

ResponseSearchInvoicePagedResultStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "invoiceId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "title": {
                    "type": "string",
                    "nullable": true
                  },
                  "number": {
                    "type": "string",
                    "nullable": true
                  },
                  "customer": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "customerId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "invoiceStatus": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceStatusId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "invoiceType": {
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "invoiceTypeId": {
                            "type": "integer",
                            "format": "int32"
                          },
                          "name": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    ],
                    "nullable": true
                  },
                  "amountCaptured": {
                    "type": "number",
                    "format": "double"
                  },
                  "remainingBalance": {
                    "type": "number",
                    "format": "double"
                  },
                  "subtotal": {
                    "type": "number",
                    "format": "double"
                  },
                  "shipping": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "total": {
                    "type": "number",
                    "format": "double"
                  },
                  "fees": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "discounts": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "tax": {
                    "type": "number",
                    "format": "double",
                    "nullable": true
                  },
                  "transactionIds": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "nullable": true
                  },
                  "invoiceDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "dueDate": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "createdDateTime": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data ResponseSearchInvoicePagedResult¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseSearchSettlement

{
  "type": "object",
  "properties": {
    "settlements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "settlementId": {
            "type": "string",
            "format": "uuid"
          },
          "gatewayId": {
            "type": "string",
            "format": "uuid"
          },
          "processorId": {
            "type": "string",
            "format": "uuid"
          },
          "processorName": {
            "type": "string",
            "nullable": true
          },
          "batchDate": {
            "type": "string",
            "format": "date-time"
          },
          "transactionsCount": {
            "type": "integer",
            "format": "int32"
          },
          "capturedAmount": {
            "type": "number",
            "format": "double"
          },
          "creditAmount": {
            "type": "number",
            "format": "double"
          },
          "surchargeAmount": {
            "type": "number",
            "format": "double"
          },
          "paymentAdjustmentAmount": {
            "type": "number",
            "format": "double"
          },
          "baseAmount": {
            "type": "number",
            "format": "double"
          },
          "netAmount": {
            "type": "number",
            "format": "double"
          },
          "netDepositeAmount": {
            "type": "number",
            "format": "double"
          },
          "responseCode": {
            "type": "integer",
            "format": "int32"
          },
          "responseMessage": {
            "type": "string",
            "nullable": true
          },
          "sourceLastActionAt": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "acceptedSettlementsStats": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionsCount": {
              "type": "integer",
              "format": "int32"
            },
            "capturedAmount": {
              "type": "number",
              "format": "double"
            },
            "creditAmount": {
              "type": "number",
              "format": "double"
            },
            "surchargeAmount": {
              "type": "number",
              "format": "double"
            },
            "paymentAdjustmentAmount": {
              "type": "number",
              "format": "double"
            },
            "baseAmount": {
              "type": "number",
              "format": "double"
            },
            "netAmount": {
              "type": "number",
              "format": "double"
            },
            "netDepositeAmount": {
              "type": "number",
              "format": "double"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    },
    "sortColumn": {
      "type": "string",
      "nullable": true
    },
    "sortDirection": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
settlements [SettlementRead]¦null false none none
acceptedSettlementsStats SettlementsStats¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none
sortColumn string¦null false none none
sortDirection string¦null false none none

ResponseSearchSettlementIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "settlements": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "settlementId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "gatewayId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "processorName": {
                    "type": "string",
                    "nullable": true
                  },
                  "batchDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "transactionsCount": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "capturedAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "creditAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "surchargeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "paymentAdjustmentAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "baseAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "netAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "netDepositeAmount": {
                    "type": "number",
                    "format": "double"
                  },
                  "responseCode": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "responseMessage": {
                    "type": "string",
                    "nullable": true
                  },
                  "sourceLastActionAt": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "acceptedSettlementsStats": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "transactionsCount": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "capturedAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "creditAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "surchargeAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "paymentAdjustmentAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "baseAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "netAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "netDepositeAmount": {
                      "type": "number",
                      "format": "double"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "offset": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            },
            "sortColumn": {
              "type": "string",
              "nullable": true
            },
            "sortDirection": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseSearchSettlement¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseSearchTransaction

{
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "format": "uuid"
    },
    "type": {
      "enum": [
        "Sale",
        "Authorize",
        "Capture",
        "Credit",
        "Refund",
        "Verification"
      ],
      "type": "string"
    },
    "paymentMethod": {
      "enum": [
        "Card",
        "Ach",
        "Token",
        "Terminal"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "Unknown",
        "Declined",
        "Authorized",
        "PendingSettlement",
        "Settled",
        "Voided",
        "Refunded",
        "Returned",
        "LateReturn",
        "Pending",
        "PartiallyRefunded"
      ],
      "type": "string"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "amountAuthorized": {
      "type": "number",
      "format": "double"
    },
    "amountCaptured": {
      "type": "number",
      "format": "double"
    },
    "amountRefunded": {
      "type": "number",
      "format": "double"
    },
    "maskedCard": {
      "type": "string",
      "nullable": true
    },
    "maskedAccount": {
      "type": "string",
      "nullable": true
    },
    "customerId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "customerName": {
      "type": "string",
      "nullable": true
    },
    "billingFirstName": {
      "type": "string",
      "nullable": true
    },
    "billingLastName": {
      "type": "string",
      "nullable": true
    },
    "invoiceId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionId string(uuid) false none none
type string false none none
paymentMethod string false none none
status string false none none
amount number(double) false none none
amountAuthorized number(double) false none none
amountCaptured number(double) false none none
amountRefunded number(double) false none none
maskedCard string¦null false none none
maskedAccount string¦null false none none
customerId string(uuid)¦null false none none
customerName string¦null false none none
billingFirstName string¦null false none none
billingLastName string¦null false none none
invoiceId string(uuid)¦null false none none
createdDateTime string(date-time) false none none

Enumerated Values

Property Value
type Sale
type Authorize
type Capture
type Credit
type Refund
type Verification
paymentMethod Card
paymentMethod Ach
paymentMethod Token
paymentMethod Terminal
status Unknown
status Declined
status Authorized
status PendingSettlement
status Settled
status Voided
status Refunded
status Returned
status LateReturn
status Pending
status PartiallyRefunded

ResponseSearchTransactionPagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "enum": [
              "Sale",
              "Authorize",
              "Capture",
              "Credit",
              "Refund",
              "Verification"
            ],
            "type": "string"
          },
          "paymentMethod": {
            "enum": [
              "Card",
              "Ach",
              "Token",
              "Terminal"
            ],
            "type": "string"
          },
          "status": {
            "enum": [
              "Unknown",
              "Declined",
              "Authorized",
              "PendingSettlement",
              "Settled",
              "Voided",
              "Refunded",
              "Returned",
              "LateReturn",
              "Pending",
              "PartiallyRefunded"
            ],
            "type": "string"
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "amountAuthorized": {
            "type": "number",
            "format": "double"
          },
          "amountCaptured": {
            "type": "number",
            "format": "double"
          },
          "amountRefunded": {
            "type": "number",
            "format": "double"
          },
          "maskedCard": {
            "type": "string",
            "nullable": true
          },
          "maskedAccount": {
            "type": "string",
            "nullable": true
          },
          "customerId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "customerName": {
            "type": "string",
            "nullable": true
          },
          "billingFirstName": {
            "type": "string",
            "nullable": true
          },
          "billingLastName": {
            "type": "string",
            "nullable": true
          },
          "invoiceId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [ResponseSearchTransaction]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

ResponseSearchTransactionPagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "enum": [
                      "Sale",
                      "Authorize",
                      "Capture",
                      "Credit",
                      "Refund",
                      "Verification"
                    ],
                    "type": "string"
                  },
                  "paymentMethod": {
                    "enum": [
                      "Card",
                      "Ach",
                      "Token",
                      "Terminal"
                    ],
                    "type": "string"
                  },
                  "status": {
                    "enum": [
                      "Unknown",
                      "Declined",
                      "Authorized",
                      "PendingSettlement",
                      "Settled",
                      "Voided",
                      "Refunded",
                      "Returned",
                      "LateReturn",
                      "Pending",
                      "PartiallyRefunded"
                    ],
                    "type": "string"
                  },
                  "amount": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountAuthorized": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountCaptured": {
                    "type": "number",
                    "format": "double"
                  },
                  "amountRefunded": {
                    "type": "number",
                    "format": "double"
                  },
                  "maskedCard": {
                    "type": "string",
                    "nullable": true
                  },
                  "maskedAccount": {
                    "type": "string",
                    "nullable": true
                  },
                  "customerId": {
                    "type": "string",
                    "format": "uuid",
                    "nullable": true
                  },
                  "customerName": {
                    "type": "string",
                    "nullable": true
                  },
                  "billingFirstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "billingLastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "invoiceId": {
                    "type": "string",
                    "format": "uuid",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ResponseSearchTransactionPagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

ResponseTransactionAddress

{
  "type": "object",
  "properties": {
    "transactionAddressId": {
      "type": "string",
      "format": "uuid"
    },
    "isPhysical": {
      "type": "boolean"
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "firstName": {
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "type": "string",
      "nullable": true
    },
    "company": {
      "type": "string",
      "nullable": true
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "type": "string",
      "nullable": true
    },
    "fax": {
      "type": "string",
      "nullable": true
    },
    "addressLine1": {
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "type": "string",
      "nullable": true
    },
    "city": {
      "type": "string",
      "nullable": true
    },
    "state": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionAddressId string(uuid) false none none
isPhysical boolean false none none
isShipping boolean false none none
isBilling boolean false none none
firstName string¦null false none none
lastName string¦null false none none
company string¦null false none none
email string¦null false none none
phone string¦null false none none
fax string¦null false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none

ResponseTransactionPaymentMethod

{
  "type": "object",
  "properties": {
    "transactionPaymentMethodId": {
      "type": "string",
      "format": "uuid"
    },
    "ach": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedAccount": {
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string"
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "card": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "maskedCard": {
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress"
              ],
              "type": "string"
            },
            "expirationDate": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "avsResponse": {
      "type": "string",
      "nullable": true
    },
    "cvvResponse": {
      "type": "string",
      "nullable": true
    },
    "cardHolderName": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionPaymentMethodId string(uuid) false none none
ach ResponseTransactionReadAch¦null false none none
card ResponseTransactionReadCard¦null false none none
avsResponse string¦null false none none
cvvResponse string¦null false none none
cardHolderName string¦null false none none

ResponseTransactionReadAch

{
  "type": "object",
  "properties": {
    "maskedAccount": {
      "type": "string",
      "nullable": true
    },
    "accountType": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string"
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedAccount string¦null false none none
accountType string false none none
secCode string false none none

Enumerated Values

Property Value
accountType Checking
accountType Savings
secCode PPD
secCode CCD
secCode WEB
secCode TEL

ResponseTransactionReadCard

{
  "type": "object",
  "properties": {
    "maskedCard": {
      "type": "string",
      "nullable": true
    },
    "cardType": {
      "enum": [
        "Visa",
        "MasterCard",
        "Discover",
        "AmericanExpress"
      ],
      "type": "string"
    },
    "expirationDate": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
maskedCard string¦null false none none
cardType string false none none
expirationDate string¦null false none none

Enumerated Values

Property Value
cardType Visa
cardType MasterCard
cardType Discover
cardType AmericanExpress

ResponseTransactionReadGateway

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none
name string¦null false none none

ResponseTransactionReadProcessor

{
  "type": "object",
  "properties": {
    "processorId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
processorId string(uuid) false none none
name string¦null false none none
type string¦null false none none

RoleDetailsResponse

{
  "type": "object",
  "properties": {
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "code": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "isGatewayRole": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
roleId string(uuid) false none none
code string¦null false none none
description string¦null false none none
isGatewayRole boolean false none none

RoleDetailsResponseListIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "roleId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "isGatewayRole": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [RoleDetailsResponse]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

SageAchSetting

{
  "type": "object",
  "properties": {
    "terminals": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "terminalId": {
            "type": "string",
            "nullable": true
          },
          "secCode": {
            "enum": [
              "PPD",
              "CCD",
              "WEB",
              "TEL"
            ],
            "type": "string"
          },
          "type": {
            "enum": [
              "OneTime",
              "Recurring"
            ],
            "type": "string"
          },
          "dlRequired": {
            "type": "boolean"
          },
          "idRequired": {
            "type": "boolean"
          },
          "checkVerification": {
            "type": "boolean"
          },
          "isGatewayTerminal": {
            "type": "boolean"
          },
          "allowCredits": {
            "type": "boolean"
          },
          "checkLimit": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "hasLevel2Verification": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
terminals [SageProcessorTerminal]¦null false none none
hasLevel2Verification boolean false none none

SageProcessorTerminal

{
  "type": "object",
  "properties": {
    "terminalId": {
      "type": "string",
      "nullable": true
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string"
    },
    "type": {
      "enum": [
        "OneTime",
        "Recurring"
      ],
      "type": "string"
    },
    "dlRequired": {
      "type": "boolean"
    },
    "idRequired": {
      "type": "boolean"
    },
    "checkVerification": {
      "type": "boolean"
    },
    "isGatewayTerminal": {
      "type": "boolean"
    },
    "allowCredits": {
      "type": "boolean"
    },
    "checkLimit": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
terminalId string¦null false none none
secCode string false none none
type string false none none
dlRequired boolean false none none
idRequired boolean false none none
checkVerification boolean false none none
isGatewayTerminal boolean false none none
allowCredits boolean false none none
checkLimit integer(int32) false none none

Enumerated Values

Property Value
secCode PPD
secCode CCD
secCode WEB
secCode TEL
type OneTime
type Recurring

SavedSearchDetailsResponse

{
  "type": "object",
  "properties": {
    "savedSearchId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "schemaVersion": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "enum": [
        "Transaction",
        "Settlement",
        "Customer"
      ],
      "type": "string"
    },
    "value": {
      "type": "string",
      "nullable": true
    },
    "gatewayScoped": {
      "type": "boolean"
    },
    "gatewayId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
savedSearchId string(uuid) false none none
name string¦null false none none
schemaVersion string¦null false none none
type string false none none
value string¦null false none none
gatewayScoped boolean false none none
gatewayId string(uuid)¦null false none none

Enumerated Values

Property Value
type Transaction
type Settlement
type Customer

SavedSearchDetailsResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "schemaVersion": {
              "type": "string",
              "nullable": true
            },
            "type": {
              "enum": [
                "Transaction",
                "Settlement",
                "Customer"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            },
            "gatewayScoped": {
              "type": "boolean"
            },
            "gatewayId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data SavedSearchDetailsResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

SavedSearchReadResponse

{
  "type": "object",
  "properties": {
    "savedSearchId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "gatewayScoped": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
savedSearchId string(uuid) false none none
name string¦null false none none
gatewayScoped boolean false none none

SavedSearchReadResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "savedSearchId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "gatewayScoped": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data SavedSearchReadResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

SearchFilterCreditCard

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "IsLike",
        "IsNotLike"
      ],
      "type": "string"
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string¦null false none none

Enumerated Values

Property Value
operator IsLike
operator IsNotLike

SearchFilterDateRange

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Between"
      ],
      "type": "string"
    },
    "startDate": {
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
      "type": "string",
      "nullable": true
    },
    "endDate": {
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
startDate string¦null false none none
endDate string¦null false none none

Enumerated Values

Property Value
operator Between

SearchFilterDecimal

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "IsGreaterOrEqual",
        "IsLesserOrEqual",
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "type": "number",
      "format": "double",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value number(double)¦null false none none

Enumerated Values

Property Value
operator IsGreaterOrEqual
operator IsLesserOrEqual
operator Equal
operator NotEqual

SearchFilterGuid

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string(uuid) false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual

SearchFilterInteger

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "IsGreaterOrEqual",
        "IsLesserOrEqual",
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value integer(int32)¦null false none none

Enumerated Values

Property Value
operator IsGreaterOrEqual
operator IsLesserOrEqual
operator Equal
operator NotEqual

SearchFilterString

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "IsLike",
        "IsNotLike",
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string¦null false none none

Enumerated Values

Property Value
operator IsLike
operator IsNotLike
operator Equal
operator NotEqual

SearchInvoice

{
  "type": "object",
  "properties": {
    "globalSearch": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "invoiceId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "title": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "number": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "status": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "type": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountCaptured": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "remainingBalance": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "subtotal": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shipping": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "total": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "fees": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "discounts": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "tax": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoiceDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "dueDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "modifiedDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressLine1": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressLine2": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingFirstName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingLastName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCompany": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCity": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCountry": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingState": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingPostalCode": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingEmail": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingPhone": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingFax": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "maximum": 100,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "sortColumn": {
      "pattern": "^(CreatedDateTime|DueDate|Status|CapturedAmount|RemainingBalance|InvoiceId|CustomerName|Discounts|Fees)$",
      "type": "string",
      "nullable": true
    },
    "sortDirection": {
      "pattern": "^(ASC|DESC)$",
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
globalSearch string¦null false none none
invoiceId SearchFilterGuid¦null false none none
customerId SearchFilterGuid¦null false none none
customerName SearchFilterString¦null false none none
title SearchFilterString¦null false none none
number SearchFilterString¦null false none none
status SearchFilterInteger¦null false none none
type SearchFilterInteger¦null false none none
amountCaptured SearchFilterDecimal¦null false none none
remainingBalance SearchFilterDecimal¦null false none none
subtotal SearchFilterDecimal¦null false none none
shipping SearchFilterDecimal¦null false none none
total SearchFilterDecimal¦null false none none
fees SearchFilterDecimal¦null false none none
discounts SearchFilterDecimal¦null false none none
tax SearchFilterDecimal¦null false none none
invoiceDate SearchFilterDateRange¦null false none none
dueDate SearchFilterDateRange¦null false none none
createdDateTime SearchFilterDateRange¦null false none none
modifiedDateTime SearchFilterDateRange¦null false none none
billingAddressId SearchFilterGuid¦null false none none
billingAddressLine1 SearchFilterString¦null false none none
billingAddressLine2 SearchFilterString¦null false none none
billingFirstName SearchFilterString¦null false none none
billingLastName SearchFilterString¦null false none none
billingCompany SearchFilterString¦null false none none
billingCity SearchFilterString¦null false none none
billingCountry SearchFilterString¦null false none none
billingState SearchFilterString¦null false none none
billingPostalCode SearchFilterString¦null false none none
billingEmail SearchFilterString¦null false none none
billingPhone SearchFilterString¦null false none none
billingFax SearchFilterString¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none
sortColumn string¦null false none none
sortDirection string¦null false none none

SettlementRead

{
  "type": "object",
  "properties": {
    "settlementId": {
      "type": "string",
      "format": "uuid"
    },
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    },
    "processorId": {
      "type": "string",
      "format": "uuid"
    },
    "processorName": {
      "type": "string",
      "nullable": true
    },
    "batchDate": {
      "type": "string",
      "format": "date-time"
    },
    "transactionsCount": {
      "type": "integer",
      "format": "int32"
    },
    "capturedAmount": {
      "type": "number",
      "format": "double"
    },
    "creditAmount": {
      "type": "number",
      "format": "double"
    },
    "surchargeAmount": {
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentAmount": {
      "type": "number",
      "format": "double"
    },
    "baseAmount": {
      "type": "number",
      "format": "double"
    },
    "netAmount": {
      "type": "number",
      "format": "double"
    },
    "netDepositeAmount": {
      "type": "number",
      "format": "double"
    },
    "responseCode": {
      "type": "integer",
      "format": "int32"
    },
    "responseMessage": {
      "type": "string",
      "nullable": true
    },
    "sourceLastActionAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
settlementId string(uuid) false none none
gatewayId string(uuid) false none none
processorId string(uuid) false none none
processorName string¦null false none none
batchDate string(date-time) false none none
transactionsCount integer(int32) false none none
capturedAmount number(double) false none none
creditAmount number(double) false none none
surchargeAmount number(double) false none none
paymentAdjustmentAmount number(double) false none none
baseAmount number(double) false none none
netAmount number(double) false none none
netDepositeAmount number(double) false none none
responseCode integer(int32) false none none
responseMessage string¦null false none none
sourceLastActionAt string(date-time) false none none

SettlementSearchRequest

{
  "type": "object",
  "properties": {
    "settlementId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "batchDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "processorId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "processorName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "responseCode": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "sortColumn": {
      "type": "string",
      "nullable": true
    },
    "sortDirection": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
settlementId SearchFilterGuid¦null false none none
batchDate SearchFilterDateRange¦null false none none
processorId SearchFilterGuid¦null false none none
processorName SearchFilterString¦null false none none
responseCode SearchFilterInteger¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none
sortColumn string¦null false none none
sortDirection string¦null false none none

SettlementsStats

{
  "type": "object",
  "properties": {
    "transactionsCount": {
      "type": "integer",
      "format": "int32"
    },
    "capturedAmount": {
      "type": "number",
      "format": "double"
    },
    "creditAmount": {
      "type": "number",
      "format": "double"
    },
    "surchargeAmount": {
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentAmount": {
      "type": "number",
      "format": "double"
    },
    "baseAmount": {
      "type": "number",
      "format": "double"
    },
    "netAmount": {
      "type": "number",
      "format": "double"
    },
    "netDepositeAmount": {
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionsCount integer(int32) false none none
capturedAmount number(double) false none none
creditAmount number(double) false none none
surchargeAmount number(double) false none none
paymentAdjustmentAmount number(double) false none none
baseAmount number(double) false none none
netAmount number(double) false none none
netDepositeAmount number(double) false none none

ShippingResponse

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "format": "double"
    },
    "taxPlacement": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
amount number(double) false none none
taxPlacement string¦null false none none

StatusGatewayResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none

StatusGatewayResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data StatusGatewayResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

T

{
  "type": "object",
  "additionalProperties": false
}

Properties

None

TransactionAch

{
  "required": [
    "achToken"
  ],
  "type": "object",
  "properties": {
    "achToken": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "secCode": {
      "enum": [
        "PPD",
        "CCD",
        "WEB",
        "TEL"
      ],
      "type": "string",
      "nullable": true
    },
    "routingNumber": {
      "type": "string",
      "nullable": true
    },
    "accountType": {
      "enum": [
        "Checking",
        "Savings"
      ],
      "type": "string",
      "nullable": true
    },
    "checkNumber": {
      "type": "string",
      "nullable": true
    },
    "accountHolderAuth": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "dlState": {
              "type": "string",
              "nullable": true
            },
            "dlNumber": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
achToken string true none none
secCode string¦null false none none
routingNumber string¦null false none none
accountType string¦null false none none
checkNumber string¦null false none none
accountHolderAuth AchAccountHolderAuth¦null false none none

Enumerated Values

Property Value
secCode PPD
secCode CCD
secCode WEB
secCode TEL
accountType Checking
accountType Savings

TransactionAddress

{
  "required": [
    "isBilling",
    "isPhysical",
    "isShipping"
  ],
  "type": "object",
  "properties": {
    "isPhysical": {
      "type": "boolean"
    },
    "isShipping": {
      "type": "boolean"
    },
    "isBilling": {
      "type": "boolean"
    },
    "firstName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "company": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "email": {
      "maxLength": 100,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "fax": {
      "maxLength": 10,
      "pattern": "^(\\d{10})$",
      "type": "string",
      "nullable": true
    },
    "addressLine1": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "addressLine2": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "city": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "maxLength": 10,
      "type": "string",
      "nullable": true
    },
    "country": {
      "maxLength": 40,
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isPhysical boolean true none none
isShipping boolean true none none
isBilling boolean true none none
firstName string¦null false none none
lastName string¦null false none none
company string¦null false none none
email string¦null false none none
phone string¦null false none none
fax string¦null false none none
addressLine1 string¦null false none none
addressLine2 string¦null false none none
city string¦null false none none
state string¦null false none none
postalCode string¦null false none none
country string¦null false none none

TransactionCaptureModel

{
  "required": [
    "amount"
  ],
  "type": "object",
  "properties": {
    "amount": {
      "minimum": 0.01,
      "type": "number",
      "format": "double"
    },
    "cardPresentPayload": {
      "allOf": [
        {
          "required": [
            "dataWireId",
            "groupId",
            "merchantId",
            "terminalId",
            "transaction"
          ],
          "type": "object",
          "properties": {
            "transaction": {
              "allOf": [
                {
                  "required": [
                    "captureData",
                    "tenderData",
                    "transactionData"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderData": {
                      "allOf": [
                        {
                          "required": [
                            "tenderType",
                            "token"
                          ],
                          "type": "object",
                          "properties": {
                            "tenderType": {
                              "enum": [
                                "ProcessAsCredit",
                                "ProcessAsDebit"
                              ],
                              "type": "string"
                            },
                            "cardSecurityData": {
                              "allOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "cvData": {
                                      "type": "string",
                                      "nullable": true
                                    }
                                  },
                                  "additionalProperties": false
                                }
                              ],
                              "nullable": true
                            },
                            "token": {
                              "minLength": 1,
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    },
                    "transactionData": {
                      "allOf": [
                        {
                          "required": [
                            "entryMode",
                            "timeZone",
                            "transactionId",
                            "transactionIsoDate"
                          ],
                          "type": "object",
                          "properties": {
                            "transactionIsoDate": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "timeZone": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "transactionId": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "entryMode": {
                              "enum": [
                                "Swiped",
                                "Keyed",
                                "Contact",
                                "Contactless"
                              ],
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    },
                    "captureData": {
                      "allOf": [
                        {
                          "required": [
                            "originalAuthCode",
                            "originalCardResponse",
                            "originalReferenceIsoDateTime",
                            "originalReferenceNumber",
                            "originalResponseCode",
                            "originalStan"
                          ],
                          "type": "object",
                          "properties": {
                            "originalReferenceNumber": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalReferenceIsoDateTime": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalStan": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalResponseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string"
                            },
                            "originalAuthCode": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalCardResponse": {
                              "minLength": 1,
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "merchantId": {
              "minLength": 1,
              "type": "string"
            },
            "dataWireId": {
              "minLength": 1,
              "type": "string"
            },
            "terminalId": {
              "minLength": 1,
              "type": "string"
            },
            "groupId": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
amount number(double) true none none
cardPresentPayload CPCapturePayload¦null false none none

TransactionCard

{
  "required": [
    "cardToken",
    "maskedNumber"
  ],
  "type": "object",
  "properties": {
    "cardToken": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "cardType": {
      "enum": [
        "Visa",
        "MasterCard",
        "Discover",
        "AmericanExpress"
      ],
      "type": "string",
      "nullable": true
    },
    "expirationDate": {
      "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
      "type": "string",
      "nullable": true
    },
    "maskedNumber": {
      "minLength": 1,
      "pattern": "^\\d{6}\\*{6,}\\d{4}$",
      "type": "string"
    },
    "entryType": {
      "enum": [
        "Swiped",
        "Keyed",
        "Contact",
        "Contactless"
      ],
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cardToken string true none none
cardType string¦null false none none
expirationDate string¦null false none none
maskedNumber string true none none
entryType string¦null false none none

Enumerated Values

Property Value
cardType Visa
cardType MasterCard
cardType Discover
cardType AmericanExpress
entryType Swiped
entryType Keyed
entryType Contact
entryType Contactless

TransactionDetailResponse

{
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "format": "uuid"
    },
    "invoiceId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "referencedTransactionId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "type": {
      "enum": [
        "Sale",
        "Authorize",
        "Capture",
        "Credit",
        "Refund",
        "Verification"
      ],
      "type": "string"
    },
    "state": {
      "enum": [
        "Active",
        "MigrationFailure",
        "Archived"
      ],
      "type": "string"
    },
    "paymentMethod": {
      "enum": [
        "Card",
        "Ach",
        "Token",
        "Terminal"
      ],
      "type": "string"
    },
    "paymentType": {
      "enum": [
        "Card",
        "Ach",
        "Token",
        "Terminal"
      ],
      "type": "string"
    },
    "poNumber": {
      "type": "string",
      "nullable": true
    },
    "ipAddress": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "transactionSource": {
      "enum": [
        "Cp",
        "Webhook",
        "Api",
        "Batch",
        "Invoice",
        "Cart",
        "Recurring"
      ],
      "type": "string"
    },
    "emailReceipt": {
      "type": "boolean"
    },
    "emailAddress": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "Unknown",
        "Declined",
        "Authorized",
        "PendingSettlement",
        "Settled",
        "Voided",
        "Refunded",
        "Returned",
        "LateReturn",
        "Pending",
        "PartiallyRefunded"
      ],
      "type": "string"
    },
    "response": {
      "type": "string",
      "nullable": true
    },
    "responseCode": {
      "type": "string",
      "nullable": true
    },
    "authCode": {
      "type": "string",
      "nullable": true
    },
    "processorResponseCode": {
      "type": "string",
      "nullable": true
    },
    "processorResponseText": {
      "type": "string",
      "nullable": true
    },
    "processor": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "processorId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            },
            "type": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "sourceProperties": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "sourceUserName": {
              "type": "string",
              "nullable": true
            },
            "sourceTransactionId": {
              "type": "string",
              "nullable": true
            },
            "sourceSettlementBatchId": {
              "type": "string",
              "nullable": true
            },
            "sourceOrderId": {
              "type": "string",
              "nullable": true
            },
            "sourceLastActionAt": {
              "type": "string",
              "format": "date-time",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "transactionRemit": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "baseAmount": {
              "type": "number",
              "format": "double"
            },
            "amount": {
              "type": "number",
              "format": "double"
            },
            "amountAuthorized": {
              "type": "number",
              "format": "double"
            },
            "amountCaptured": {
              "type": "number",
              "format": "double"
            },
            "amountSettled": {
              "type": "number",
              "format": "double"
            },
            "amountRefunded": {
              "type": "number",
              "format": "double"
            },
            "taxAmount": {
              "type": "number",
              "format": "double"
            },
            "paymentAdjustmentType": {
              "enum": [
                "NoAdj",
                "Flat",
                "Percentage"
              ],
              "type": "string",
              "nullable": true
            },
            "paymentAdjustmentValue": {
              "type": "number",
              "format": "double"
            },
            "tip": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "cashBack": {
              "type": "number",
              "format": "double",
              "nullable": true
            },
            "taxExempt": {
              "type": "boolean"
            },
            "shippingAmount": {
              "type": "number",
              "format": "double"
            },
            "surcharge": {
              "type": "number",
              "format": "double"
            },
            "discountAmount": {
              "type": "number",
              "format": "double"
            },
            "serviceFee": {
              "type": "number",
              "format": "double"
            },
            "nationalTaxAmount": {
              "type": "number",
              "format": "double"
            },
            "dutyAmount": {
              "type": "number",
              "format": "double"
            },
            "currencyCode": {
              "enum": [
                "USD"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "transactionAddresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transactionAddressId": {
            "type": "string",
            "format": "uuid"
          },
          "isPhysical": {
            "type": "boolean"
          },
          "isShipping": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "company": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "fax": {
            "type": "string",
            "nullable": true
          },
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "transactionPaymentMethod": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionPaymentMethodId": {
              "type": "string",
              "format": "uuid"
            },
            "ach": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedAccount": {
                      "type": "string",
                      "nullable": true
                    },
                    "accountType": {
                      "enum": [
                        "Checking",
                        "Savings"
                      ],
                      "type": "string"
                    },
                    "secCode": {
                      "enum": [
                        "PPD",
                        "CCD",
                        "WEB",
                        "TEL"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "card": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "maskedCard": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardType": {
                      "enum": [
                        "Visa",
                        "MasterCard",
                        "Discover",
                        "AmericanExpress"
                      ],
                      "type": "string"
                    },
                    "expirationDate": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "avsResponse": {
              "type": "string",
              "nullable": true
            },
            "cvvResponse": {
              "type": "string",
              "nullable": true
            },
            "cardHolderName": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customer": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "capturedDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "settledDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "settlementId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "createdByUser": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayUserId": {
              "type": "string",
              "format": "uuid"
            },
            "firstName": {
              "type": "string",
              "nullable": true
            },
            "lastName": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "gateway": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            },
            "name": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "transactionFeatures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "displayName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "customFieldEntries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "customFieldId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "modifiedByUserId": {
            "type": "string",
            "format": "uuid"
          },
          "modifiedDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryName": {
            "type": "string",
            "nullable": true
          },
          "customFieldCategoryId": {
            "type": "integer",
            "format": "int32"
          },
          "dataType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
transactionId string(uuid) false none none
invoiceId string(uuid)¦null false none none
referencedTransactionId string(uuid)¦null false none none
type string false none none
state string false none none
paymentMethod string false none none
paymentType string false none none
poNumber string¦null false none none
ipAddress string¦null false none none
description string¦null false none none
transactionSource string false none none
emailReceipt boolean false none none
emailAddress string¦null false none none
status string false none none
response string¦null false none none
responseCode string¦null false none none
authCode string¦null false none none
processorResponseCode string¦null false none none
processorResponseText string¦null false none none
processor ResponseTransactionReadProcessor¦null false none none
sourceProperties ResponseReadSourceProperties¦null false none none
transactionRemit ResponseReadTransactionRemit¦null false none none
transactionAddresses [ResponseTransactionAddress]¦null false none none
transactionPaymentMethod ResponseTransactionPaymentMethod¦null false none none
customer TransactionReadCustomer¦null false none none
createdDateTime string(date-time) false none none
modifiedDateTime string(date-time) false none none
capturedDateTime string(date-time)¦null false none none
settledDateTime string(date-time)¦null false none none
settlementId string(uuid)¦null false none none
createdByUser ResponseReadTransactionReadGatewayUser¦null false none none
gateway ResponseTransactionReadGateway¦null false none none
transactionFeatures [ResponseReadTransactionFeature]¦null false none none
customFieldEntries [CustomFieldEntryModel]¦null false none none

Enumerated Values

Property Value
type Sale
type Authorize
type Capture
type Credit
type Refund
type Verification
state Active
state MigrationFailure
state Archived
paymentMethod Card
paymentMethod Ach
paymentMethod Token
paymentMethod Terminal
paymentType Card
paymentType Ach
paymentType Token
paymentType Terminal
transactionSource Cp
transactionSource Webhook
transactionSource Api
transactionSource Batch
transactionSource Invoice
transactionSource Cart
transactionSource Recurring
status Unknown
status Declined
status Authorized
status PendingSettlement
status Settled
status Voided
status Refunded
status Returned
status LateReturn
status Pending
status PartiallyRefunded

TransactionDetailResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "transactionId": {
              "type": "string",
              "format": "uuid"
            },
            "invoiceId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "referencedTransactionId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "type": {
              "enum": [
                "Sale",
                "Authorize",
                "Capture",
                "Credit",
                "Refund",
                "Verification"
              ],
              "type": "string"
            },
            "state": {
              "enum": [
                "Active",
                "MigrationFailure",
                "Archived"
              ],
              "type": "string"
            },
            "paymentMethod": {
              "enum": [
                "Card",
                "Ach",
                "Token",
                "Terminal"
              ],
              "type": "string"
            },
            "paymentType": {
              "enum": [
                "Card",
                "Ach",
                "Token",
                "Terminal"
              ],
              "type": "string"
            },
            "poNumber": {
              "type": "string",
              "nullable": true
            },
            "ipAddress": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "transactionSource": {
              "enum": [
                "Cp",
                "Webhook",
                "Api",
                "Batch",
                "Invoice",
                "Cart",
                "Recurring"
              ],
              "type": "string"
            },
            "emailReceipt": {
              "type": "boolean"
            },
            "emailAddress": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string"
            },
            "response": {
              "type": "string",
              "nullable": true
            },
            "responseCode": {
              "type": "string",
              "nullable": true
            },
            "authCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseCode": {
              "type": "string",
              "nullable": true
            },
            "processorResponseText": {
              "type": "string",
              "nullable": true
            },
            "processor": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "processorId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    },
                    "type": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "sourceProperties": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "sourceUserName": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceTransactionId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceSettlementBatchId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceOrderId": {
                      "type": "string",
                      "nullable": true
                    },
                    "sourceLastActionAt": {
                      "type": "string",
                      "format": "date-time",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionRemit": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "baseAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "amount": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountAuthorized": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountCaptured": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountSettled": {
                      "type": "number",
                      "format": "double"
                    },
                    "amountRefunded": {
                      "type": "number",
                      "format": "double"
                    },
                    "taxAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "paymentAdjustmentType": {
                      "enum": [
                        "NoAdj",
                        "Flat",
                        "Percentage"
                      ],
                      "type": "string",
                      "nullable": true
                    },
                    "paymentAdjustmentValue": {
                      "type": "number",
                      "format": "double"
                    },
                    "tip": {
                      "type": "number",
                      "format": "double",
                      "nullable": true
                    },
                    "cashBack": {
                      "type": "number",
                      "format": "double",
                      "nullable": true
                    },
                    "taxExempt": {
                      "type": "boolean"
                    },
                    "shippingAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "surcharge": {
                      "type": "number",
                      "format": "double"
                    },
                    "discountAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "serviceFee": {
                      "type": "number",
                      "format": "double"
                    },
                    "nationalTaxAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "dutyAmount": {
                      "type": "number",
                      "format": "double"
                    },
                    "currencyCode": {
                      "enum": [
                        "USD"
                      ],
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionAddresses": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "transactionAddressId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "isPhysical": {
                    "type": "boolean"
                  },
                  "isShipping": {
                    "type": "boolean"
                  },
                  "isBilling": {
                    "type": "boolean"
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "phone": {
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine1": {
                    "type": "string",
                    "nullable": true
                  },
                  "addressLine2": {
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "transactionPaymentMethod": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "transactionPaymentMethodId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "ach": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "maskedAccount": {
                              "type": "string",
                              "nullable": true
                            },
                            "accountType": {
                              "enum": [
                                "Checking",
                                "Savings"
                              ],
                              "type": "string"
                            },
                            "secCode": {
                              "enum": [
                                "PPD",
                                "CCD",
                                "WEB",
                                "TEL"
                              ],
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "card": {
                      "allOf": [
                        {
                          "type": "object",
                          "properties": {
                            "maskedCard": {
                              "type": "string",
                              "nullable": true
                            },
                            "cardType": {
                              "enum": [
                                "Visa",
                                "MasterCard",
                                "Discover",
                                "AmericanExpress"
                              ],
                              "type": "string"
                            },
                            "expirationDate": {
                              "type": "string",
                              "nullable": true
                            }
                          },
                          "additionalProperties": false
                        }
                      ],
                      "nullable": true
                    },
                    "avsResponse": {
                      "type": "string",
                      "nullable": true
                    },
                    "cvvResponse": {
                      "type": "string",
                      "nullable": true
                    },
                    "cardHolderName": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "customer": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "customerId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "modifiedDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "capturedDateTime": {
              "type": "string",
              "format": "date-time",
              "nullable": true
            },
            "settledDateTime": {
              "type": "string",
              "format": "date-time",
              "nullable": true
            },
            "settlementId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "createdByUser": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayUserId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "firstName": {
                      "type": "string",
                      "nullable": true
                    },
                    "lastName": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "gateway": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "gatewayId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            },
            "transactionFeatures": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "displayName": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "customFieldEntries": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "customFieldId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "name": {
                    "type": "string",
                    "nullable": true
                  },
                  "value": {
                    "type": "string",
                    "nullable": true
                  },
                  "modifiedByUserId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "modifiedDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "type": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryName": {
                    "type": "string",
                    "nullable": true
                  },
                  "customFieldCategoryId": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "dataType": {
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data TransactionDetailResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

TransactionFeesModel

{
  "required": [
    "addTaxToTotal",
    "baseAmount",
    "creditCardBin",
    "processorId"
  ],
  "type": "object",
  "properties": {
    "creditCardBin": {
      "maxLength": 6,
      "minLength": 0,
      "pattern": "^[0-9]*$",
      "type": "string"
    },
    "state": {
      "maxLength": 3,
      "type": "string",
      "nullable": true
    },
    "baseAmount": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string",
      "nullable": true
    },
    "paymentAdjustmentValue": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "addTaxToTotal": {
      "type": "boolean"
    },
    "taxAmount": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "processorId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
creditCardBin string true none none
state string¦null false none none
baseAmount number(double) true none none
paymentAdjustmentType string¦null false none none
paymentAdjustmentValue number(double)¦null false none none
addTaxToTotal boolean true none none
taxAmount number(double) false none none
processorId string(uuid) true none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage

TransactionFeesResponseModel

{
  "type": "object",
  "properties": {
    "isSurchargeable": {
      "type": "boolean"
    },
    "surchargeAmount": {
      "type": "number",
      "format": "double"
    },
    "serviceFeesAmount": {
      "type": "number",
      "format": "double"
    },
    "convenienceFeesAmount": {
      "type": "number",
      "format": "double"
    },
    "baseAmount": {
      "type": "number",
      "format": "double"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "taxAmount": {
      "type": "number",
      "format": "double"
    },
    "cardBrand": {
      "type": "string",
      "nullable": true
    },
    "cardType": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isSurchargeable boolean false none none
surchargeAmount number(double) false none none
serviceFeesAmount number(double) false none none
convenienceFeesAmount number(double) false none none
baseAmount number(double) false none none
amount number(double) false none none
taxAmount number(double) false none none
cardBrand string¦null false none none
cardType string¦null false none none

TransactionFeesResponseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "isSurchargeable": {
              "type": "boolean"
            },
            "surchargeAmount": {
              "type": "number",
              "format": "double"
            },
            "serviceFeesAmount": {
              "type": "number",
              "format": "double"
            },
            "convenienceFeesAmount": {
              "type": "number",
              "format": "double"
            },
            "baseAmount": {
              "type": "number",
              "format": "double"
            },
            "amount": {
              "type": "number",
              "format": "double"
            },
            "taxAmount": {
              "type": "number",
              "format": "double"
            },
            "cardBrand": {
              "type": "string",
              "nullable": true
            },
            "cardType": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data TransactionFeesResponseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

TransactionFeesResponseModelListStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "isSurchargeable": {
            "type": "boolean"
          },
          "surchargeAmount": {
            "type": "number",
            "format": "double"
          },
          "serviceFeesAmount": {
            "type": "number",
            "format": "double"
          },
          "convenienceFeesAmount": {
            "type": "number",
            "format": "double"
          },
          "baseAmount": {
            "type": "number",
            "format": "double"
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "taxAmount": {
            "type": "number",
            "format": "double"
          },
          "cardBrand": {
            "type": "string",
            "nullable": true
          },
          "cardType": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data [TransactionFeesResponseModel]¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

TransactionPaymentAdjustment

{
  "required": [
    "paymentAdjustmentType",
    "paymentAdjustmentValue"
  ],
  "type": "object",
  "properties": {
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string"
    },
    "paymentAdjustmentValue": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
paymentAdjustmentType string true none none
paymentAdjustmentValue number(double) true none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage

TransactionPaymentMethod

{
  "type": "object",
  "properties": {
    "card": {
      "allOf": [
        {
          "required": [
            "cardToken",
            "maskedNumber"
          ],
          "type": "object",
          "properties": {
            "cardToken": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "cardType": {
              "enum": [
                "Visa",
                "MasterCard",
                "Discover",
                "AmericanExpress"
              ],
              "type": "string",
              "nullable": true
            },
            "expirationDate": {
              "pattern": "([1][0-2]|[0][1-9])\\/[0-9][0-9]",
              "type": "string",
              "nullable": true
            },
            "maskedNumber": {
              "minLength": 1,
              "pattern": "^\\d{6}\\*{6,}\\d{4}$",
              "type": "string"
            },
            "entryType": {
              "enum": [
                "Swiped",
                "Keyed",
                "Contact",
                "Contactless"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "ach": {
      "allOf": [
        {
          "required": [
            "achToken"
          ],
          "type": "object",
          "properties": {
            "achToken": {
              "maxLength": 50,
              "minLength": 1,
              "type": "string"
            },
            "secCode": {
              "enum": [
                "PPD",
                "CCD",
                "WEB",
                "TEL"
              ],
              "type": "string",
              "nullable": true
            },
            "routingNumber": {
              "type": "string",
              "nullable": true
            },
            "accountType": {
              "enum": [
                "Checking",
                "Savings"
              ],
              "type": "string",
              "nullable": true
            },
            "checkNumber": {
              "type": "string",
              "nullable": true
            },
            "accountHolderAuth": {
              "allOf": [
                {
                  "type": "object",
                  "properties": {
                    "dlState": {
                      "type": "string",
                      "nullable": true
                    },
                    "dlNumber": {
                      "type": "string",
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                }
              ],
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customer": {
      "allOf": [
        {
          "required": [
            "customerId"
          ],
          "type": "object",
          "properties": {
            "customerId": {
              "type": "string",
              "format": "uuid"
            },
            "customerPaymentMethodId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "customerBillingAddressId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            },
            "customerShippingAddressId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
card TransactionCard¦null false none none
ach TransactionAch¦null false none none
customer TransactionProcessCustomer¦null false none none

TransactionProcessCustomer

{
  "required": [
    "customerId"
  ],
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid"
    },
    "customerPaymentMethodId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "customerBillingAddressId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    },
    "customerShippingAddressId": {
      "type": "string",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid) true none none
customerPaymentMethodId string(uuid)¦null false none none
customerBillingAddressId string(uuid)¦null false none none
customerShippingAddressId string(uuid)¦null false none none

TransactionReadCustomer

{
  "type": "object",
  "properties": {
    "customerId": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
customerId string(uuid) false none none
name string¦null false none none

TransactionRefundModel

{
  "required": [
    "amount"
  ],
  "type": "object",
  "properties": {
    "amount": {
      "minimum": 0.01,
      "pattern": "^\\d+(\\.\\d{1,2})?$",
      "type": "number",
      "format": "double"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
amount number(double) true none none

TransactionRemit

{
  "required": [
    "baseAmount",
    "currencyCode",
    "taxAmount"
  ],
  "type": "object",
  "properties": {
    "baseAmount": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "taxAmount": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "isTaxExempt": {
      "type": "boolean"
    },
    "currencyCode": {
      "enum": [
        "USD"
      ],
      "type": "string"
    },
    "addTaxToTotal": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
baseAmount number(double) true none none
taxAmount number(double) true none none
isTaxExempt boolean false none none
currencyCode string true none none
addTaxToTotal boolean false none none

Enumerated Values

Property Value
currencyCode USD

TransactionSearchRequest

{
  "type": "object",
  "properties": {
    "amount": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountAuthorized": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountCaptured": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "amountSettled": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "taxAmount": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsGreaterOrEqual",
                "IsLesserOrEqual",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "capturedDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "settledDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "modifiedDateTime": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "creditCardFirst6": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "creditCardLast4": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "achRoutingNumber": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "customerName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "ipAddress": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "poNumber": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "processorId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "processorName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "referenceTransactionId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "settlementBatchId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "status": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "Unknown",
                "Declined",
                "Authorized",
                "PendingSettlement",
                "Settled",
                "Voided",
                "Refunded",
                "Returned",
                "LateReturn",
                "Pending",
                "PartiallyRefunded"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "transactionId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "source": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "Cp",
                "Webhook",
                "Api",
                "Batch",
                "Invoice",
                "Cart",
                "Recurring"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "type": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "Sale",
                "Authorize",
                "Capture",
                "Credit",
                "Refund",
                "Verification"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "userName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "userId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "invoiceId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressLine1": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingAddressLine2": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingFirstName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingLastName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCompany": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCity": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingCountry": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingState": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingPostalCode": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingEmail": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingPhone": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "billingFax": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingAddressId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingAddressLine1": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingAddressLine2": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingFirstName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingLastName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingCompany": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingCity": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingCountry": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingState": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingPostalCode": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingEmail": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingPhone": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "shippingFax": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "sortColumn": {
      "pattern": "^(CreatedDateTime|Status|CustomerName|MaskedAccount|MaskedCard|Amount)$",
      "type": "string",
      "nullable": true
    },
    "sortDirection": {
      "pattern": "^(DESC|ASC)$",
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
amount SearchFilterDecimal¦null false none none
amountAuthorized SearchFilterDecimal¦null false none none
amountCaptured SearchFilterDecimal¦null false none none
amountSettled SearchFilterDecimal¦null false none none
taxAmount SearchFilterDecimal¦null false none none
capturedDateTime SearchFilterDateRange¦null false none none
settledDateTime SearchFilterDateRange¦null false none none
createdDateTime SearchFilterDateRange¦null false none none
modifiedDateTime SearchFilterDateRange¦null false none none
creditCardFirst6 SearchFilterCreditCard¦null false none none
creditCardLast4 SearchFilterCreditCard¦null false none none
achRoutingNumber SearchFilterString¦null false none none
customerId SearchFilterGuid¦null false none none
customerName SearchFilterString¦null false none none
ipAddress SearchFilterString¦null false none none
poNumber SearchFilterString¦null false none none
processorId SearchFilterGuid¦null false none none
processorName SearchFilterString¦null false none none
referenceTransactionId SearchFilterGuid¦null false none none
settlementBatchId SearchFilterString¦null false none none
status TransactionStatusSearchFilterEnum¦null false none none
transactionId SearchFilterGuid¦null false none none
source TransactionSourceSearchFilterEnum¦null false none none
type TransactionTypeSearchFilterEnum¦null false none none
userName SearchFilterString¦null false none none
userId SearchFilterGuid¦null false none none
invoiceId SearchFilterGuid¦null false none none
billingAddressId SearchFilterGuid¦null false none none
billingAddressLine1 SearchFilterString¦null false none none
billingAddressLine2 SearchFilterString¦null false none none
billingFirstName SearchFilterString¦null false none none
billingLastName SearchFilterString¦null false none none
billingCompany SearchFilterString¦null false none none
billingCity SearchFilterString¦null false none none
billingCountry SearchFilterString¦null false none none
billingState SearchFilterString¦null false none none
billingPostalCode SearchFilterString¦null false none none
billingEmail SearchFilterString¦null false none none
billingPhone SearchFilterString¦null false none none
billingFax SearchFilterString¦null false none none
shippingAddressId SearchFilterGuid¦null false none none
shippingAddressLine1 SearchFilterString¦null false none none
shippingAddressLine2 SearchFilterString¦null false none none
shippingFirstName SearchFilterString¦null false none none
shippingLastName SearchFilterString¦null false none none
shippingCompany SearchFilterString¦null false none none
shippingCity SearchFilterString¦null false none none
shippingCountry SearchFilterString¦null false none none
shippingState SearchFilterString¦null false none none
shippingPostalCode SearchFilterString¦null false none none
shippingEmail SearchFilterString¦null false none none
shippingPhone SearchFilterString¦null false none none
shippingFax SearchFilterString¦null false none none
offset integer(int32) false none none
limit integer(int32) false none none
sortColumn string¦null false none none
sortDirection string¦null false none none

TransactionSourceSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "Cp",
        "Webhook",
        "Api",
        "Batch",
        "Invoice",
        "Cart",
        "Recurring"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value Cp
value Webhook
value Api
value Batch
value Invoice
value Cart
value Recurring

TransactionStatusSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "Unknown",
        "Declined",
        "Authorized",
        "PendingSettlement",
        "Settled",
        "Voided",
        "Refunded",
        "Returned",
        "LateReturn",
        "Pending",
        "PartiallyRefunded"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value Unknown
value Declined
value Authorized
value PendingSettlement
value Settled
value Voided
value Refunded
value Returned
value LateReturn
value Pending
value PartiallyRefunded

TransactionTypeSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "Sale",
        "Authorize",
        "Capture",
        "Credit",
        "Refund",
        "Verification"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value Sale
value Authorize
value Capture
value Credit
value Refund
value Verification

TransactionVoidModel

{
  "type": "object",
  "properties": {
    "cardPresentPayload": {
      "allOf": [
        {
          "required": [
            "dataWireId",
            "groupId",
            "merchantId",
            "terminalId",
            "transaction"
          ],
          "type": "object",
          "properties": {
            "transaction": {
              "allOf": [
                {
                  "required": [
                    "tenderData",
                    "transactionData",
                    "voidData"
                  ],
                  "type": "object",
                  "properties": {
                    "tenderData": {
                      "allOf": [
                        {
                          "required": [
                            "tenderType",
                            "token"
                          ],
                          "type": "object",
                          "properties": {
                            "tenderType": {
                              "enum": [
                                "ProcessAsCredit",
                                "ProcessAsDebit"
                              ],
                              "type": "string"
                            },
                            "cardSecurityData": {
                              "allOf": [
                                {
                                  "type": "object",
                                  "properties": {
                                    "cvData": {
                                      "type": "string",
                                      "nullable": true
                                    }
                                  },
                                  "additionalProperties": false
                                }
                              ],
                              "nullable": true
                            },
                            "token": {
                              "minLength": 1,
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    },
                    "transactionData": {
                      "allOf": [
                        {
                          "required": [
                            "entryMode",
                            "merchantCategoryCode",
                            "timeZone",
                            "transactionId",
                            "transactionIsoDate"
                          ],
                          "type": "object",
                          "properties": {
                            "transactionIsoDate": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "timeZone": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "transactionId": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "entryMode": {
                              "enum": [
                                "Swiped",
                                "Keyed",
                                "Contact",
                                "Contactless"
                              ],
                              "type": "string"
                            },
                            "merchantCategoryCode": {
                              "minLength": 1,
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    },
                    "voidData": {
                      "allOf": [
                        {
                          "required": [
                            "originalAuthCode",
                            "originalCardResponse",
                            "originalReferenceIsoDateTime",
                            "originalReferenceNumber",
                            "originalResponseCode",
                            "originalStan"
                          ],
                          "type": "object",
                          "properties": {
                            "originalReferenceNumber": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalReferenceIsoDateTime": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalStan": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalResponseCode": {
                              "enum": [
                                "UNKN",
                                "DECL",
                                "APPR"
                              ],
                              "type": "string"
                            },
                            "originalAuthCode": {
                              "minLength": 1,
                              "type": "string"
                            },
                            "originalCardResponse": {
                              "minLength": 1,
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        }
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              ]
            },
            "merchantId": {
              "minLength": 1,
              "type": "string"
            },
            "dataWireId": {
              "minLength": 1,
              "type": "string"
            },
            "terminalId": {
              "minLength": 1,
              "type": "string"
            },
            "groupId": {
              "minLength": 1,
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
cardPresentPayload CPVoidPayload¦null false none none

TsysSierraSetting

{
  "type": "object",
  "properties": {
    "bin": {
      "type": "string",
      "nullable": true
    },
    "mid": {
      "type": "string",
      "nullable": true
    },
    "mvv": {
      "type": "string",
      "nullable": true
    },
    "agentBankNumber": {
      "type": "string",
      "nullable": true
    },
    "agentChainNumber": {
      "type": "string",
      "nullable": true
    },
    "storeNumber": {
      "type": "string",
      "nullable": true
    },
    "terminalNumber": {
      "type": "string",
      "nullable": true
    },
    "industryCode": {
      "enum": [
        "Unknown",
        "A",
        "B",
        "D",
        "F",
        "G",
        "H",
        "L",
        "O",
        "P",
        "R"
      ],
      "type": "string"
    },
    "currencyCode": {
      "type": "string",
      "nullable": true
    },
    "countryCode": {
      "type": "string",
      "nullable": true
    },
    "cityCode": {
      "type": "string",
      "nullable": true
    },
    "languageIndicator": {
      "type": "string",
      "nullable": true
    },
    "timeZone": {
      "type": "string",
      "nullable": true
    },
    "mcc": {
      "type": "string",
      "nullable": true
    },
    "merchantName": {
      "type": "string",
      "nullable": true
    },
    "merchantLocation": {
      "type": "string",
      "nullable": true
    },
    "merchantState": {
      "type": "string",
      "nullable": true
    },
    "merchantLocationNumber": {
      "type": "string",
      "nullable": true
    },
    "classification": {
      "enum": [
        "Ecomm",
        "MOTO",
        "Retail"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
bin string¦null false none none
mid string¦null false none none
mvv string¦null false none none
agentBankNumber string¦null false none none
agentChainNumber string¦null false none none
storeNumber string¦null false none none
terminalNumber string¦null false none none
industryCode string false none none
currencyCode string¦null false none none
countryCode string¦null false none none
cityCode string¦null false none none
languageIndicator string¦null false none none
timeZone string¦null false none none
mcc string¦null false none none
merchantName string¦null false none none
merchantLocation string¦null false none none
merchantState string¦null false none none
merchantLocationNumber string¦null false none none
classification string false none none

Enumerated Values

Property Value
industryCode Unknown
industryCode A
industryCode B
industryCode D
industryCode F
industryCode G
industryCode H
industryCode L
industryCode O
industryCode P
industryCode R
classification Ecomm
classification MOTO
classification Retail

UpdateGatewayConfigurationModel

{
  "required": [
    "categoryCode",
    "fieldEntryValues"
  ],
  "type": "object",
  "properties": {
    "categoryCode": {
      "minLength": 1,
      "type": "string"
    },
    "fieldEntryValues": {
      "type": "array",
      "items": {
        "required": [
          "fieldCode",
          "fieldValue"
        ],
        "type": "object",
        "properties": {
          "fieldCode": {
            "minLength": 1,
            "type": "string"
          },
          "fieldValue": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
categoryCode string true none none
fieldEntryValues [GatewayConfigurationFieldEntryValueModel] true none none

UpdateGatewayConfigurationResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none

UpdateGatewayConfigurationResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data UpdateGatewayConfigurationResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UpdateGatewayModel

{
  "required": [
    "name",
    "phone",
    "receiptEmail",
    "timezone"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 60,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9\\-&\\., ]+$",
      "type": "string"
    },
    "merchantId": {
      "maxLength": 25,
      "type": "string",
      "nullable": true
    },
    "feeScheduleId": {
      "type": "string",
      "nullable": true
    },
    "phone": {
      "maxLength": 10,
      "minLength": 1,
      "pattern": "^(\\d{10})$",
      "type": "string"
    },
    "phoneExtention": {
      "maxLength": 10,
      "type": "string",
      "nullable": true
    },
    "receiptEmail": {
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string"
    },
    "website": {
      "maxLength": 100,
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "gatewayAddressId": {
            "type": "string",
            "format": "uuid",
            "nullable": true
          },
          "isPrimary": {
            "type": "boolean"
          },
          "isBilling": {
            "type": "boolean"
          },
          "isInvoice": {
            "type": "boolean"
          },
          "addressModel": {
            "allOf": [
              {
                "required": [
                  "addressLine1",
                  "firstName"
                ],
                "type": "object",
                "properties": {
                  "addressLine1": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "addressLine2": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "city": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "state": {
                    "maxLength": 3,
                    "type": "string",
                    "nullable": true
                  },
                  "postalCode": {
                    "maxLength": 16,
                    "type": "string",
                    "nullable": true
                  },
                  "country": {
                    "maxLength": 40,
                    "type": "string",
                    "nullable": true
                  },
                  "firstName": {
                    "maxLength": 50,
                    "minLength": 1,
                    "type": "string"
                  },
                  "lastName": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  },
                  "email": {
                    "maxLength": 100,
                    "type": "string",
                    "format": "email",
                    "nullable": true
                  },
                  "phone": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "fax": {
                    "maxLength": 10,
                    "pattern": "^(\\d{10})$",
                    "type": "string",
                    "nullable": true
                  },
                  "company": {
                    "maxLength": 50,
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "gatewaySettings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
merchantId string¦null false none none
feeScheduleId string¦null false none none
phone string true none none
phoneExtention string¦null false none none
receiptEmail string true none none
website string¦null false none none
timezone string true none none
addresses [GatewayAddressUpdateModel]¦null false none none
gatewaySettings [InsertGatewaySetting]¦null false none none

UpdateGatewayResponse

{
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
gatewayId string(uuid) false none none

UpdateGatewayResponseStatus

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string"
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "gatewayId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false none none
statusDetails [string]¦null false none none
data UpdateGatewayResponse¦null false none none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UpdateProcessorModel

{
  "required": [
    "name",
    "paymentAdjustmentType",
    "paymentAdjustmentValue",
    "processorType",
    "timezone"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "processorType": {
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "maxLength": 50,
      "type": "string",
      "nullable": true
    },
    "timezone": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string"
    },
    "settleAt": {
      "type": "string",
      "format": "date-span"
    },
    "paymentAdjustmentType": {
      "enum": [
        "NoAdj",
        "Flat",
        "Percentage"
      ],
      "type": "string"
    },
    "paymentAdjustmentValue": {
      "pattern": "^[-+]?(?:\\d{1,14}(?:\\.\\d{1,4})?|\\.\\d{1,4})$",
      "type": "number",
      "format": "double"
    },
    "isDefaultCard": {
      "type": "boolean"
    },
    "isDefaultAch": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
name string true none none
processorType string true none none
description string¦null false none none
timezone string true none none
settleAt string(date-span) false none none
paymentAdjustmentType string true none none
paymentAdjustmentValue number(double) true none none
isDefaultCard boolean false none none
isDefaultAch boolean false none none

Enumerated Values

Property Value
paymentAdjustmentType NoAdj
paymentAdjustmentType Flat
paymentAdjustmentType Percentage

UserCreateModel

{
  "required": [
    "email",
    "firstName",
    "lastName",
    "roleId"
  ],
  "type": "object",
  "properties": {
    "email": {
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string"
    },
    "firstName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "permissionIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
email string true none none
firstName string true none none
lastName string true none none
roleId string(uuid) true none none
permissionIds [string]¦null false none none

UserDetailResponse

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "format": "uuid"
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "firstName": {
      "type": "string",
      "nullable": true
    },
    "lastName": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "string",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "userPermissions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "order": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "userRole": {
      "enum": [
        "SU",
        "SA",
        "GA",
        "GS"
      ],
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
userId string(uuid) false none none
email string¦null false none none
firstName string¦null false none none
lastName string¦null false none none
status string¦null false none none
createdDateTime string(date-time) false none none
userPermissions [UserPermission]¦null false none none
userRole string¦null false none none

Enumerated Values

Property Value
userRole SU
userRole SA
userRole GA
userRole GS

UserDetailResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "firstName": {
              "type": "string",
              "nullable": true
            },
            "lastName": {
              "type": "string",
              "nullable": true
            },
            "status": {
              "type": "string",
              "nullable": true
            },
            "createdDateTime": {
              "type": "string",
              "format": "date-time"
            },
            "userPermissions": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "permissionId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "code": {
                    "type": "string",
                    "nullable": true
                  },
                  "description": {
                    "type": "string",
                    "nullable": true
                  },
                  "order": {
                    "type": "integer",
                    "format": "int32"
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "userRole": {
              "enum": [
                "SU",
                "SA",
                "GA",
                "GS"
              ],
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data UserDetailResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UserDetailResponsePagedResult

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "format": "uuid"
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "createdDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "userPermissions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "permissionId": {
                  "type": "string",
                  "format": "uuid"
                },
                "code": {
                  "type": "string",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "nullable": true
                },
                "order": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "additionalProperties": false
            },
            "nullable": true
          },
          "userRole": {
            "enum": [
              "SU",
              "SA",
              "GA",
              "GS"
            ],
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "offSet": {
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "rowCount": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
results [UserDetailResponse]¦null false none none
offSet integer(int32) false none none
limit integer(int32) false none none
rowCount integer(int32) false none none

UserDetailResponsePagedResultIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "results": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "userId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "email": {
                    "type": "string",
                    "nullable": true
                  },
                  "firstName": {
                    "type": "string",
                    "nullable": true
                  },
                  "lastName": {
                    "type": "string",
                    "nullable": true
                  },
                  "status": {
                    "type": "string",
                    "nullable": true
                  },
                  "createdDateTime": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "userPermissions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "permissionId": {
                          "type": "string",
                          "format": "uuid"
                        },
                        "code": {
                          "type": "string",
                          "nullable": true
                        },
                        "description": {
                          "type": "string",
                          "nullable": true
                        },
                        "order": {
                          "type": "integer",
                          "format": "int32"
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  },
                  "userRole": {
                    "enum": [
                      "SU",
                      "SA",
                      "GA",
                      "GS"
                    ],
                    "type": "string",
                    "nullable": true
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            },
            "offSet": {
              "type": "integer",
              "format": "int32"
            },
            "limit": {
              "type": "integer",
              "format": "int32"
            },
            "rowCount": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data UserDetailResponsePagedResult¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UserDetailsBaseModel

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
userId string(uuid) false none none

UserDetailsBaseModelIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data UserDetailsBaseModel¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UserPermission

{
  "type": "object",
  "properties": {
    "permissionId": {
      "type": "string",
      "format": "uuid"
    },
    "code": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "order": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
permissionId string(uuid) false none none
code string¦null false none none
description string¦null false none none
order integer(int32) false none none

UserPermissionIEnumerableIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionId": {
            "type": "string",
            "format": "uuid"
          },
          "code": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "order": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data [UserPermission]¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UserPermissionIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "permissionId": {
              "type": "string",
              "format": "uuid"
            },
            "code": {
              "type": "string",
              "nullable": true
            },
            "description": {
              "type": "string",
              "nullable": true
            },
            "order": {
              "type": "integer",
              "format": "int32"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data UserPermission¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired

UserSearchRequest

{
  "type": "object",
  "properties": {
    "userId": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "format": "uuid"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "email": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "firstName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "lastName": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "IsLike",
                "IsNotLike",
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "status": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Equal",
                "NotEqual"
              ],
              "type": "string"
            },
            "value": {
              "enum": [
                "InvitePending",
                "PendingTOS",
                "Active",
                "Disabled"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "createdDate": {
      "allOf": [
        {
          "required": [
            "operator"
          ],
          "type": "object",
          "properties": {
            "operator": {
              "enum": [
                "Between"
              ],
              "type": "string"
            },
            "startDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            },
            "endDate": {
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}[Zz]?",
              "type": "string",
              "nullable": true
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true
    },
    "includeUserPermissions": {
      "type": "boolean"
    },
    "includeUserRole": {
      "type": "boolean"
    },
    "offSet": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "format": "int32"
    },
    "limit": {
      "maximum": 100,
      "minimum": 1,
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
userId SearchFilterGuid¦null false none none
email SearchFilterString¦null false none none
firstName SearchFilterString¦null false none none
lastName SearchFilterString¦null false none none
status UserStatusSearchFilterEnum¦null false none none
createdDate SearchFilterDateRange¦null false none none
includeUserPermissions boolean false none none
includeUserRole boolean false none none
offSet integer(int32) false none none
limit integer(int32) false none none

UserStatusSearchFilterEnum

{
  "required": [
    "operator"
  ],
  "type": "object",
  "properties": {
    "operator": {
      "enum": [
        "Equal",
        "NotEqual"
      ],
      "type": "string"
    },
    "value": {
      "enum": [
        "InvitePending",
        "PendingTOS",
        "Active",
        "Disabled"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
operator string true none none
value string false none none

Enumerated Values

Property Value
operator Equal
operator NotEqual
value InvitePending
value PendingTOS
value Active
value Disabled

UserUpdateModel

{
  "required": [
    "firstName",
    "lastName",
    "roleId",
    "status"
  ],
  "type": "object",
  "properties": {
    "firstName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "status": {
      "enum": [
        "InvitePending",
        "PendingTOS",
        "Active",
        "Disabled"
      ],
      "type": "string"
    },
    "roleId": {
      "type": "string",
      "format": "uuid"
    },
    "permissionIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
firstName string true none none
lastName string true none none
status string true none none
roleId string(uuid) true none none
permissionIds [string]¦null false none none

Enumerated Values

Property Value
status InvitePending
status PendingTOS
status Active
status Disabled

ValidateCreateGatewayUserRequest

{
  "required": [
    "email"
  ],
  "type": "object",
  "properties": {
    "email": {
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[a-zA-Z0-9_.+-]+@([a-zA-Z0-9-]+.)+[a-zA-Z]{2,6}$",
      "type": "string"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
email string true none none

ValidateCreateGatewayUserResponse

{
  "type": "object",
  "properties": {
    "isCreateAllowed": {
      "type": "boolean"
    },
    "accountExists": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
isCreateAllowed boolean false none none
accountExists boolean false none none

ValidateCreateGatewayUserResponseIResult

{
  "type": "object",
  "properties": {
    "statusCode": {
      "enum": [
        "Continue",
        "SwitchingProtocols",
        "Processing",
        "EarlyHints",
        "OK",
        "Created",
        "Accepted",
        "NonAuthoritativeInformation",
        "NoContent",
        "ResetContent",
        "PartialContent",
        "MultiStatus",
        "AlreadyReported",
        "IMUsed",
        "Ambiguous",
        "Moved",
        "Redirect",
        "RedirectMethod",
        "NotModified",
        "UseProxy",
        "Unused",
        "TemporaryRedirect",
        "PermanentRedirect",
        "BadRequest",
        "Unauthorized",
        "PaymentRequired",
        "Forbidden",
        "NotFound",
        "MethodNotAllowed",
        "NotAcceptable",
        "ProxyAuthenticationRequired",
        "RequestTimeout",
        "Conflict",
        "Gone",
        "LengthRequired",
        "PreconditionFailed",
        "RequestEntityTooLarge",
        "RequestUriTooLong",
        "UnsupportedMediaType",
        "RequestedRangeNotSatisfiable",
        "ExpectationFailed",
        "MisdirectedRequest",
        "UnprocessableEntity",
        "Locked",
        "FailedDependency",
        "UpgradeRequired",
        "PreconditionRequired",
        "TooManyRequests",
        "RequestHeaderFieldsTooLarge",
        "UnavailableForLegalReasons",
        "InternalServerError",
        "NotImplemented",
        "BadGateway",
        "ServiceUnavailable",
        "GatewayTimeout",
        "HttpVersionNotSupported",
        "VariantAlsoNegotiates",
        "InsufficientStorage",
        "LoopDetected",
        "NotExtended",
        "NetworkAuthenticationRequired"
      ],
      "type": "string",
      "readOnly": true
    },
    "statusDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true
    },
    "data": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "isCreateAllowed": {
              "type": "boolean"
            },
            "accountExists": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "byteData": {
      "type": "string",
      "format": "byte",
      "nullable": true,
      "readOnly": true
    },
    "contentType": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  },
  "additionalProperties": false
}

Properties

Name Type Required Restrictions Description
statusCode string false read-only none
statusDetails [string]¦null false read-only none
data ValidateCreateGatewayUserResponse¦null false read-only none
byteData string(byte)¦null false read-only none
contentType string¦null false read-only none

Enumerated Values

Property Value
statusCode Continue
statusCode SwitchingProtocols
statusCode Processing
statusCode EarlyHints
statusCode OK
statusCode Created
statusCode Accepted
statusCode NonAuthoritativeInformation
statusCode NoContent
statusCode ResetContent
statusCode PartialContent
statusCode MultiStatus
statusCode AlreadyReported
statusCode IMUsed
statusCode Ambiguous
statusCode Moved
statusCode Redirect
statusCode RedirectMethod
statusCode NotModified
statusCode UseProxy
statusCode Unused
statusCode TemporaryRedirect
statusCode PermanentRedirect
statusCode BadRequest
statusCode Unauthorized
statusCode PaymentRequired
statusCode Forbidden
statusCode NotFound
statusCode MethodNotAllowed
statusCode NotAcceptable
statusCode ProxyAuthenticationRequired
statusCode RequestTimeout
statusCode Conflict
statusCode Gone
statusCode LengthRequired
statusCode PreconditionFailed
statusCode RequestEntityTooLarge
statusCode RequestUriTooLong
statusCode UnsupportedMediaType
statusCode RequestedRangeNotSatisfiable
statusCode ExpectationFailed
statusCode MisdirectedRequest
statusCode UnprocessableEntity
statusCode Locked
statusCode FailedDependency
statusCode UpgradeRequired
statusCode PreconditionRequired
statusCode TooManyRequests
statusCode RequestHeaderFieldsTooLarge
statusCode UnavailableForLegalReasons
statusCode InternalServerError
statusCode NotImplemented
statusCode BadGateway
statusCode ServiceUnavailable
statusCode GatewayTimeout
statusCode HttpVersionNotSupported
statusCode VariantAlsoNegotiates
statusCode InsufficientStorage
statusCode LoopDetected
statusCode NotExtended
statusCode NetworkAuthenticationRequired